github/docs

add missing documentation of use cases for workflowrun states

Open

#34 987 ouverte le 18 oct. 2024

Voir sur GitHub
 (12 commentaires) (0 réactions) (0 assignés)TypeScript (67 056 forks)batch import
SME reviewedactionscontenthelp wanted

Métriques du dépôt

Stars
 (19 479 stars)
Métriques de merge PR
 (Merge moyen 3j 19h) (90 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Examinez les statuts d'exécution de workflow existants dans l'API et la documentation de GitHub Actions. Créez un diagramme d'état et décrivez les cas d'utilisation pour chaque statut, en particulier ceux peu clairs comme 'neutral' et 'stale'.
Stack technique
rest api
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitGitHub basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
78