Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(fix): reference octokit context and github event webhook payloads in variables #348

Merged
merged 2 commits into from
Oct 18, 2024

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Oct 18, 2024

Summary

This PR matches the source of the default context to what's included with octokit - highlighted in and fixes #347.

The README now 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 octokit provides 🙏

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

@zimeg zimeg added bug Something isn't working documentation Improvements or additions to documentation semver:patch labels Oct 18, 2024
@zimeg zimeg added this to the 1.x milestone Oct 18, 2024
@zimeg zimeg requested a review from a team October 18, 2024 18:55
@zimeg zimeg self-assigned this Oct 18, 2024
Copy link

codecov bot commented Oct 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.91%. Comparing base (2c86117) to head (4e7f0ef).
Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@zimeg
Copy link
Member Author

zimeg commented Oct 18, 2024

@filmaj Thank you for the quick review! ✅ 💨

@zimeg zimeg merged commit 43604b7 into main Oct 18, 2024
5 checks passed
@zimeg zimeg deleted the docs-fix-octokit-context branch October 18, 2024 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation semver:patch
Projects
None yet
2 participants