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

Jump to bottom

GitHub Actions: add more details for "workflow_run" event #4435

Closed
Morriz opened this issue Mar 10, 2021 · 8 comments
Closed

GitHub Actions: add more details for "workflow_run" event #4435

Morriz opened this issue Mar 10, 2021 · 8 comments
Labels
webhooks Content related to webhooks
Projects
Docs open source board

Comments

@Morriz
Copy link

Morriz commented Mar 10, 2021

What article on docs.github.com is affected?

https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#workflow_run

What part(s) of the article would you like to see updated?

The properties that are exposed on github.event.workflow_run.

From examples on the web I have learned about the existence of
github.event.workflow_run.conclusion
github.event.workflow_run.head_branch

And these are not documented. I expect there to be many more props available. Why don't you guys automate this process and offer generated reference documentation?

Additional information

Another request exists for this which was closed: #799
@welcome
Copy link

welcome bot commented Mar 10, 2021

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 10, 2021
@github-actions github-actions bot added this to Triage in Docs open source board Mar 10, 2021
@katanakrypto

This comment has been minimized.

Sign in to view
@janiceilene
Copy link
Contributor

Thanks for opening an issue @Morriz! I'll triage this for the team to take a look 👀

@janiceilene janiceilene added webhooks Content related to webhooks and removed triage Do not begin working on this issue until triaged by the team labels Mar 16, 2021
@janiceilene janiceilene moved this from Triage to Content review needed in Docs open source board Mar 16, 2021
@hubwriter
Copy link
Contributor

@Morriz - Many thanks for raising this issue.

We've just (yesterday) updated the page (https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#workflow_run) adding more details for the workflow_run event.

PR: #2767

I'm going to close this issue.
Thanks again.

Docs open source board automation moved this from Content review needed to Done Mar 17, 2021
@Morriz
Copy link
Author

Morriz commented Mar 17, 2021

Really? After adding this little bit:

Many workflow_run keys, such as head_branch, conclusion, and pull_requests are the same as those in a check_suite object.

you deem this issue closed?

@Morriz
Copy link
Author

Morriz commented Mar 17, 2021

If this is not re-opened I will have to open another one

@ghost

This comment has been minimized.

Sign in to view
@Morriz
Copy link
Author

Morriz commented Mar 17, 2021

Since this is a bigger issue of not having reference documentation on topics like this one I started another issue here: #4612

@devinrsmith devinrsmith mentioned this issue May 9, 2021
Closed
@lmarsden lmarsden mentioned this issue Aug 16, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
webhooks Content related to webhooks
Projects
Docs open source board
Done
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Morriz @janiceilene @hubwriter @katanakrypto