Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

workflow_dispatch inputs: description, default and options are not documented

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#46,299 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@kburym arbeitet bereits daran.

Seit 13.10.2026.

  • #46300 von @kburym — offen

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
80/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
github-actions
Bereich
documentation

Rechercherichtung

Im Artikel zur Workflow-Syntax fehlt im Abschnitt on.workflow_dispatch.inputs.<input_id> etwas: Er behandelt nur required und type. Lies die Eingabedefinitionen von workflow_dispatch in workflow-parser/src/workflow-v1.0.json (actions/languageservices), um zu bestätigen, was description, default und options bedeuten, und prüfe data/reusables/actions/workflow-dispatch-inputs-example.md für die Verwendung. Fertig ist, wenn jeder Schlüssel einen eigenen kurzen Unterabschnitt hat und options angibt, dass es nur für choice-Eingaben gilt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
TypeScript
Sterne
21k
Forks
69.1k
Ø Merge
14 Std. 57 Min.
Gemergte PRs (30 T.)
114

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus github/docs

Alle Issues in github/docs

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.