You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This action is available in the Github context, but it's the octkit context, not the Github Actions context, and I can't find any explanation for it anywhere.
#347
Closed
mecaota opened this issue
Oct 18, 2024
· 2 comments
· Fixed by #348
In this Actions, it is stated that the github context is available and that if payload json file is prepared, it will be parsed, but this is not the github context of Github Actions, but the context provided by octokit. This is misleading due to insufficient explanation in the current documentation. Please state in the documentation that it is the octokit context.
Even if you write it according to the context described in the Github Actions documentation, it will be parsed as "???" because the octokit github context is different from the camel case and snake case, and the context itself provided is different.
I spent an hour trying to solve this. The documentation is very unhelpful.
The text was updated successfully, but these errors were encountered:
Hey @mecaota 👋 Thank you so much for reporting this!
These variables have caused a lot of confusion before, some of it in #226, and I appreciate you pointing to a cause for some missing variables 🙏
The octokit context you shared is what I'm finding in the actual action, and wrapped within the payload is details for the webhook event.
I'm sorry about the added confusion this caused - I'm thinking the similar context naming has been confusing before. We'll update this documentation soon 📚
The README now references the different possibilities of these payloads 🚀
I think we can improve this with examples in follow up changes, but right now these are better details on payloads share IMO. Thank you again for sharing these links!
slack-github-action/src/slack-send.js
Line 45 in 2c86117
In this Actions, it is stated that the github context is available and that if payload json file is prepared, it will be parsed, but this is not the github context of Github Actions, but the context provided by octokit. This is misleading due to insufficient explanation in the current documentation. Please state in the documentation that it is the octokit context.
Even if you write it according to the context described in the Github Actions documentation, it will be parsed as "???" because the octokit github context is different from the camel case and snake case, and the context itself provided is different.
I spent an hour trying to solve this. The documentation is very unhelpful.
The text was updated successfully, but these errors were encountered: