docs(fix): reference octokit context and github event webhook payloads in variables #348
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #348 +/- ##
=======================================
Coverage 97.91% 97.91%
=======================================
Files 2 2
Lines 96 96
=======================================
Hits 94 94
Misses 2 2 ☔ View full report in Codecov by Sentry. |
filmaj
approved these changes
Oct 18, 2024
|
@filmaj Thank you for the quick review! ✅ 💨 |
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
This PR matches the source of the default
contextto what's included withoctokit- highlighted in and fixes #347.The
READMEnow references the octokit context and the webhook event payloads provided as a default, with the option to provide custom payloads. 🚀Reviewers
Here's an example workflow run where this default context is logged - it matches what
octokitprovides 🙏Notes
Overall we might want to include more details about how payloads are parsed in this "Sending Variables" section, but I think that'd be alright in following changes! 📚
Dreams might exist to make use of the repo Wiki for more examples and nuance, but this also might be better for follow up.
Requirements