docs: shortens readme due to new tools site docs #424
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lukegalbraithrussell
temporarily deployed
to
staging
GitHub Actions
Inactive
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #424 +/- ##
=======================================
Coverage 99.85% 99.85%
=======================================
Files 7 7
Lines 702 702
=======================================
Hits 701 701
Misses 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
zimeg
approved these changes
Apr 3, 2025
Comment on lines
-22
to
-39
| ## Sending variables | ||
|
|
||
| There are different [techniques to send data](#sending-techniques) into Slack | ||
| and whichever one is chosen will require a certain set of customized inputs, as | ||
| described later. | ||
|
|
||
| You can provide data to send to Slack from this GitHub Action and either source: | ||
|
|
||
| - The default event [context][event-context] with a [payload][event-payload] | ||
| matching the GitHub event. | ||
| - A custom payload with optional [variables][variables] provided in the GitHub | ||
| Action step. | ||
|
|
||
| These input options are valid for all techniques, but some techniques require | ||
| specific constraints with certain requirements for valid inputs. | ||
|
|
||
| Additional [configurations](#additional-configurations) and other details are | ||
| also available for more customizations to the provided payload. |
There was a problem hiding this comment.
🤔 I'm thinking this section might be nice to include on the website's sidebar?
Linking to a specific technique left some confusion about these details for me 🔍
There was a problem hiding this comment.
ohhh yeah i can see that. i'll make a follow up task!
Co-authored-by: Eden Zimbelman <[email protected]>
lukegalbraithrussell
temporarily deployed
to
staging
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
README short because docs site long
Requirements (place an
xin each[ ])