github/docs

add missing documentation of use cases for workflowrun states

Open

#34.987 aberto em 18 de out. de 2024

Ver no GitHub
 (12 comments) (0 reactions) (0 assignees)TypeScript (67.056 forks)batch import
SME reviewedactionscontenthelp wanted

Métricas do repositório

Stars
 (19.479 stars)
Métricas de merge de PR
 (Mesclagem média 3d 19h) (90 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Investigue os status de execução do workflow existentes na API e na documentação do GitHub Actions. Crie um diagrama de estados e descreva os casos de uso para cada status, especialmente os pouco claros como 'neutral' e 'stale'.
Pilha de tecnologia
rest api
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitGitHub basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
78