Update Managing Rulesets in regards to status checks

Aperta Adatta ai principianti
#41,757 8 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
74/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
github-actions
Ambito
documentation

Direzione di ricerca

Inizia con la sezione “Require status checks to pass before merging” dell’articolo Managing Rulesets collegato e confrontala con la documentazione esistente sui status checks. Aggiorna la documentazione per spiegare che i job di GitHub Actions possono essere status checks, incluso il modo in cui la chiave name di un job del workflow viene usata in un ruleset e un breve esempio o una guida passo passo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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!

Lingua principale
TypeScript
Stelle
20.9k
Fork
68.8k
Merge medio
13h 55m
PR unite (30g)
105

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/docs

Tutte le issue di github/docs

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.