Workflow syntax reference doesn't document top-level `description` key
I maintainer di solito rispondono entro 1 giorno
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
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- github, yaml
- Ambito
- documentation
Direzione di ricerca
Inizia dalla guida di riferimento sulla sintassi dei workflow nella pagina di documentazione collegata e confronta le chiavi di primo livello documentate con la voce description nello schema del workflow collegato. Consulta le linee guida per contribuire alla documentazione del repository per individuare il file sorgente e il workflow di anteprima. Il lavoro è completo quando la guida spiega se description è supportata a livello di root, a cosa serve e se compare nell’UI.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax
What part(s) of the article would you like to see updated?
The top-level keys documented are name, run-name, on, permissions, env, defaults, concurrency, cache-mode and jobs. There's no entry for description.
GitHub's own workflow schema has accepted a root-level description since January 2025:
- actions/languageservices@50b08a3 ("Add root-level description keyword") added it to
workflow-rootinworkflow-v1.0.json, with the description "A description for your workflow or reusable workflow", plus a test fixture. - The same key is in the runner's copy of the schema: actions/runner
src/Sdk/WorkflowParser/workflow-v1.0.json.
Could the reference add a description section saying whether it's supported, what it's for (e.g. describing reusable workflows), and whether it's shown anywhere in the UI?
Additional information
Because it isn't documented, third-party tools that follow the docs reject it. actionlint (v1.7.12, latest) reports unexpected key "description" for "workflow" section, and the SchemaStore github-workflow.json schema, used by many editors' YAML validation, doesn't allow it either. Meanwhile the official GitHub Actions VS Code extension accepts it. We ran into this reviewing a reusable workflow, where different tools gave opposite answers about whether the file was valid.
- Lingua principale
- TypeScript
- Stelle
- 21.3k
- Fork
- 69.4k
- Merge medio
- 12h 12m
- PR unite (30g)
- 84
Preparare l'ambiente
Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di github/docs
-
content triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Confusing content: evaluates the expression `hash "package-lock.json"` to derive the final key `npm-d5ea0750`Forse già presa @darshpatel1052 l’ha presa 4 giorni fa. Apertaactions builder persona content
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 86/100
github/docs#46499 · 3 commenti · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
builder persona
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
github/docs#46354 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
builder persona content copilot
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
github/docs#46334 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
on.workflow_call.inputs.<input_id> description, required and default have no headingsForse di nuovo libera Una pull request per questa issue è stata chiusa senza essere unita. Apertaactions builder persona
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
github/docs#46304 · 4 commenti ·
I maintainer di solito rispondono entro 1 giorno
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
tensorflow/tfjs#8754 ·
-
tool-submission
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 83/100
BraveOPotato/NoSignups#2348 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
code-yeongyu/oh-my-openagent#12784 ·
I maintainer di solito rispondono entro 1 giorno
-
external-issue to-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 71/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
MomsBloomOrg/momsbloom-resources#84 ·
I maintainer di solito rispondono entro 1 giorno