github/docs

add missing documentation of use cases for workflowrun states

Open

#34,987 opened on Oct 18, 2024

View on GitHub
 (12 comments) (0 reactions) (0 assignees)TypeScript (19,479 stars) (67,056 forks)batch import
SME reviewedactionscontenthelp wanted

Description

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

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic understanding of GitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the existing documentation at https://docs.github.com/en/rest/actions/workflow runs?apiVersion=2022-11-28#list workflow runs for a repository. Identify all workflow run statuses (e.g., neutral, stale, queued, requested, waiting, pending, action required). For each status, research its meaning and typical triggers from GitHub's documentation or source code. Consider creating a state diagram to illustrate transitions. Also check the linked community discussion (https://github.com/orgs/community/discussions/70540#discussioncomment 10978598) for additional context. Update the relevant pages to include descriptions and the diagram.
add missing documentation of use cases for workflowrun states · github/docs#34987 | Good First Issue