github/docs

add missing documentation of use cases for workflowrun states

Open

#34.987 geöffnet am 18. Okt. 2024

Auf GitHub ansehen
 (12 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (67.056 Forks)batch import
SME reviewedactionscontenthelp wanted

Repository-Metriken

Stars
 (19.479 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 3T 19h) (90 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Untersuchen Sie die vorhandenen Workflow Ausführungsstatus in der GitHub Actions API und der Dokumentation. Erstellen Sie ein Zustandsdiagramm und beschreiben Sie Anwendungsfälle für jeden Status, insbesondere für unklare wie 'neutral' und 'stale'.
Tech Stack
rest api
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitGitHub basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
78