Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

workflow_dispatch inputs: description, default and options are not documented

Aperta Adatta ai principianti
  • Qualcosa non va?
#46,299 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@kburym ci sta già lavorando.

Dal 13/10/2026.

  • #46300 di @kburym — aperta

Valutazione

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

Direzione di ricerca

La lacuna riguarda la sezione on.workflow_dispatch.inputs.<input_id> dell'articolo sulla sintassi dei workflow, che copre solo required e type. Leggi le definizioni degli input di workflow_dispatch in workflow-parser/src/workflow-v1.0.json (actions/languageservices) per confermare il significato di description, default e options, e controlla data/reusables/actions/workflow-dispatch-inputs-example.md per l'uso. È completato quando ogni chiave ha una propria breve sottosezione e options indica che si applica solo agli input choice.

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

Descrizione

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.

Lingua principale
TypeScript
Stelle
21k
Fork
69.1k
Merge medio
14h 57m
PR unite (30g)
114

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

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.