-
Notifications
You must be signed in to change notification settings - Fork 62.5k
Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_call
What part(s) of the article would you like to see updated?
The paragraph for the "workflow_call" event is somewhat ambiguous with the mixing terms of "webhook payload" and "event payload", and says;
the event payload in the called workflow is the same event payload from the calling workflow
But there is a distinction in naming between the "webhook" payload and the "event" payload across the rest of the docs. When reading this description, it implies that there would be a webhook payload associed with the workflow_call event, perhaps one mentioned on https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads (although there is none) that would simply have the same github.event
payload as calling workflow, but that the other generic "webhook" payload fields would be equivalent to others.
For example, I assumed upon reading it that the github.event_name
field, being not in the github.event
payload, would equal workflow_call
, and was surprised to discover that the event name was also the same as that of the "webhook payload" that initiated the callee workflow.
This description could be made more clear by saying that it adopts the "webhook" payload of the callee, rather than just the "event" payload.
Additional information
No response