Update Managing Rulesets in regards to status checks

Abierto Apto para principiantes
#41,757 8 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
74/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
github-actions
Área
documentation

Línea de trabajo

Comienza con la sección “Require status checks to pass before merging” del artículo Managing Rulesets enlazado y compárala con la documentación existente sobre status checks. Actualiza la documentación para explicar que los jobs de GitHub Actions pueden ser status checks, incluido cómo se usa la clave name de un job de workflow en un ruleset y un ejemplo breve o una guía paso a paso.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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!

Lenguaje dominante
TypeScript
Estrellas
20.9k
Forks
68.8k
Merge medio
15 h 4 min
PR fusionados (30 d)
103

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/docs

Todos los issues de github/docs

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.