github/docs

add missing documentation of use cases for workflowrun states

Open

#34.987 aperta il 18 ott 2024

Vedi su GitHub
 (12 commenti) (0 reazioni) (0 assegnatari)TypeScript (67.056 fork)batch import
SME reviewedactionscontenthelp wanted

Metriche repository

Star
 (19.479 star)
Metriche merge PR
 (Merge medio 3g 19h) (90 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Indaga gli stati di esecuzione del flusso di lavoro esistenti nell'API e nella documentazione di GitHub Actions. Crea un diagramma di stato e descrivi i casi d'uso per ciascuno stato, in particolare quelli poco chiari come 'neutral' e 'stale'.
Tech stack
rest api
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitGitHub basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
78