search

github / docs

The open-source repo for docs.github.com
https://docs.github.com
Creative Commons Attribution 4.0 International
16.41k stars 60.01k forks source link

add missing documentation of use cases for workflowrun states #34987

Open tomsit-ionos opened 1 month ago

tomsit-ionos commented 1 month ago

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 commented 1 month ago

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

nguyenalex836 commented 1 month ago

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

github-actions[bot] commented 1 month ago

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

tomsit-ionos commented 1 month ago

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

queued -> in_progress -> queued -> completed

xxx2585 commented 2 weeks ago

[Uploading Getting-Started.md…]()