Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

workflow_dispatch inputs: description, default and options are not documented

Aberta Para iniciantes
  • Algo errado?
#46,299 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

@kburym já está trabalhando nisso.

Desde 13/10/2026.

  • #46300 de @kburym — aberto

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
80/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
github-actions
Domínio
documentation

Direção de pesquisa

A lacuna está na seção on.workflow_dispatch.inputs.<input_id> do artigo sobre sintaxe de workflows, que cobre apenas required e type. Leia as definições de entrada de workflow_dispatch em workflow-parser/src/workflow-v1.0.json (actions/languageservices) para confirmar o que significam description, default e options, e verifique data/reusables/actions/workflow-dispatch-inputs-example.md para ver o uso. Está concluído quando cada chave tiver sua própria subseção curta e options disser que se aplica somente a entradas choice.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_dispatchinputs

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

The on.workflow_dispatch.inputs.<input_id> section documents only required and type. The description, default and options keys are not documented as headings, although the example on the same page uses all three (options for a choice input).

The workflow schema in actions/languageservices (workflow-parser/src/workflow-v1.0.json, at fb5c6e4) defines these keys for workflow_dispatch inputs:

  • description: a string description of the input parameter.
  • default: used when an input parameter isn't specified in a workflow file.
  • options: a sequence of strings; the options of the dropdown list, if the type is choice.

Suggested change: add a short section for each of on.workflow_dispatch.inputs.<input_id>.description, .default and .options, with the options section stating that it applies only to choice inputs.

Additional information

The example in data/reusables/actions/workflow-dispatch-inputs-example.md already shows options with type: choice.

Linguagem predominante
TypeScript
Estrelas
21k
Forks
69.1k
Merge médio
14h 57min
PRs com merge (30d)
114

Preparar o ambiente

Abrir no Codespaces

Inicia o contêiner de desenvolvimento do projeto no navegador, com a sua própria conta do GitHub.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de github/docs

Todas as issues de github/docs

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.