Update Managing Rulesets in regards to status checks

Aberta Para iniciantes
#41,757 8 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
74/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
github-actions
Domínio
documentation

Direção de pesquisa

Comece pela seção “Require status checks to pass before merging” do artigo Managing Rulesets vinculado e compare-a com a documentação existente sobre status checks. Atualize a documentação para explicar que jobs do GitHub Actions podem ser status checks, incluindo como a chave name de um job de workflow é usada em um ruleset e um exemplo breve ou um guia passo a passo.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

content github_actions needs SME Waiting on SME review
Code of Conduct
What article on docs.github.com is affected?

https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-status-checks-to-pass-before-merging

What part(s) of the article would you like to see updated?

The Require Status Checks Before Merging section should more clearly mention that Github Actions (through their jobs) can be configured as status checks. The Github documentation page for status checks does mention this, however on the Managing Rulesets page it does not. More importantly, there should be instructions on how to add a workflow job as a status check on this page--I was unable to find how to do this in any official documentation available. A workflow's job-level name key can be used to add a status check in a ruleset. This should either be explained in full on the Managing Rulesets page, and if not there, then it should either be its own page or perhaps as part of the status check documentation. Providing users a brief example/step-by-step guide is not only helpful, but makes this process more transparent AND highly reputable since it would be in official documentation itself.

Additional information

Feel free to message me with any questions or feedback. Thank you!

Linguagem predominante
TypeScript
Estrelas
20.9k
Forks
68.8k
Merge médio
15h 4min
PRs com merge (30d)
103

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de github/docs

Todas as issues de github/docs

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.