Workflow syntax reference doesn't document top-level `description` key
Mantenedores costumam responder em até 1 dia
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
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- github, yaml
- Domínio
- documentation
Direção de pesquisa
Comece pela referência de sintaxe de workflows na página de documentação vinculada e compare as chaves de nível superior documentadas com a entrada description no esquema de workflow vinculado. Consulte as diretrizes de contribuição para a documentação do repositório para encontrar o arquivo de origem e o fluxo de trabalho de pré-visualização. A tarefa estará concluída quando a referência explicar se description no nível raiz é compatível, qual é sua finalidade e se aparece na UI.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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.
- Linguagem predominante
- TypeScript
- Estrelas
- 21.3k
- Forks
- 69.4k
- Merge médio
- 12h 12min
- PRs com merge (30d)
- 84
Preparar o ambiente
Inicia o contêiner de desenvolvimento do projeto no navegador, com a sua própria conta do GitHub.
- Inclui um Dockerfile ou arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de github/docs
-
content triage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Mantenedores costumam responder em até 1 dia
-
Confusing content: evaluates the expression `hash "package-lock.json"` to derive the final key `npm-d5ea0750`Talvez já em andamento @darshpatel1052 assumiu há 4 dias. Abertaactions builder persona content
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 86/100
github/docs#46499 · 3 comentários · 1 reação ·
Mantenedores costumam responder em até 1 dia
-
builder persona
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 88/100
github/docs#46354 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
builder persona content copilot
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 72/100
github/docs#46334 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
on.workflow_call.inputs.<input_id> description, required and default have no headingsTalvez livre de novo Um pull request para esta issue foi fechado sem ser mesclado. Abertaactions builder persona
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
github/docs#46304 · 4 comentários ·
Mantenedores costumam responder em até 1 dia
Todas as issues de github/docs
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
tensorflow/tfjs#8754 ·
-
tool-submission
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 83/100
BraveOPotato/NoSignups#2348 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
code-yeongyu/oh-my-openagent#12784 ·
Mantenedores costumam responder em até 1 dia
-
external-issue to-triage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 71/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
MomsBloomOrg/momsbloom-resources#84 ·
Mantenedores costumam responder em até 1 dia