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.

Sign up for GitHub

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

add missing documentation of use cases for workflowrun states #34987

Open
1 task done
tomsit-ionos opened this issue Oct 18, 2024 · 4 comments
Open
1 task done

add missing documentation of use cases for workflowrun states #34987

tomsit-ionos opened this issue Oct 18, 2024 · 4 comments
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team needs SME This proposal needs review from a subject matter expert waiting for review Issue/PR is waiting for a writer's review

Comments

@tomsit-ionos
Copy link

tomsit-ionos commented Oct 18, 2024 •
edited
Loading

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/actions/workflow-runs?apiVersion=2022-11-28#list-workflow-runs-for-a-repository

but should be linked/included on all other pages that are concerned with the WF run status

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

most of the statuses are self explanatory but there is a gray area.

  1. Plz provide a description/use case/trigger for each of the statuses, preferably with a state diagram.
    In particular i would like to know:

    the meaning of these: neutral, stale
    the difference/relation of these: queued, requested, waiting, pending, action_required

  2. Delineate which value belongs to which property as per the above doc:
    image

Additional information

PS: this is a rehash from here: https://github.com/orgs/community/discussions/70540#discussioncomment-10978598

No response
@tomsit-ionos tomsit-ionos added the content This issue or pull request belongs to the Docs Content team label Oct 18, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 18, 2024
@tomsit-ionos
Copy link
Author

btw: i just found this case: "conclusion": "startup_failure"

@nguyenalex836 nguyenalex836 added actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Oct 18, 2024
@nguyenalex836
Copy link
Contributor

@tomsit-ionos Thank you for raising this issue! I'll get this triaged for review ✨ Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

@nguyenalex836 nguyenalex836 added the needs SME This proposal needs review from a subject matter expert label Oct 18, 2024
@github-actions GitHub Actions
Copy link
Contributor

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

@tomsit-ionos
Copy link
Author

also it is not quite obvious why the workflow can transition like so:

queued -> in_progress -> queued -> completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team needs SME This proposal needs review from a subject matter expert waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nguyenalex836 @tomsit-ionos