Clarify 'description' key is optional for composite actions

Aperta
#43,910 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
github-actions
Ambito
documentation

Direzione di ricerca

Inizia con l’articolo sulla sintassi dei metadati all’indirizzo docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax e rivedi la pull request collegata per verificare la formulazione proposta. Aggiorna il requisito relativo alla descrizione di composite-action per riflettere che è facoltativa, indicando al contempo che è altamente consigliata, quindi verifica che l’articolo venga visualizzato correttamente.

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

Descrizione

content github_actions
Code of Conduct
What article on docs.github.com is affected?

https://docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax

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

For composite actions, the description key is not strictly required in the action.yml for the composite action to function correctly (see Additional Information for proof).

Instead of Required this should either have an addendum like in the pull request (that is, that description is not required for composite actions, or change Required to optional. In either case, it is probably worth it to state that a description key is highly recommended.

Additional information

I just ran a workflow run that calls a composite action whose action.yml file did not include a description key at the time this workflow ran. The workflow ran as expected (all the composite action does is produce an output that gets passed to the calling workflow).

See https://github.com/mcummings128/gh-actions-outputs-experiments-1/actions/runs/24743176941 for details.
This commit SHA shows the description key was removed from the composite action during the time the workflow ran.
https://github.com/mcummings128/gh-actions-outputs-experiments-1/commit/6037d82f9910c7d186845393ab2b4a53617b2bde

Lastly, please see the pull request this is linked to: https://github.com/github/docs/pull/43911

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.