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

workflow-syntax reference: `description`, `default` and `options` keys for `on.workflow_dispatch.inputs.<input_id>` are undocumented

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#46,354 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

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

Rechercherichtung

Beginne mit content/actions/reference/workflows-and-actions/workflow-syntax.md und suche den Abschnitt on.workflow_dispatch.inputs.<input_id>, insbesondere die vorhandenen Unterabschnitte required und type. Füge passende Unterabschnitte für description, default und options hinzu, einschließlich der im Issue beschriebenen Einschränkungen für choice. Die Aufgabe ist abgeschlossen, wenn alle drei Schlüssel dort in der vorgeschlagenen Reihenfolge und im vorgeschlagenen Stil dokumentiert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

triage

Where the gap is

content/actions/reference/workflows-and-actions/workflow-syntax.md documents required and type for on.workflow_dispatch.inputs.<input_id>, but three sibling keys that the workflow syntax accepts are missing from the reference:

  • description: a string describing the input, shown in the workflow dispatch UI
  • default: the value used when the workflow is triggered manually without a value supplied
  • options: the list of strings shown in the dropdown for an input whose type is choice

Why it matters

The workflow syntax reference is the page people land on when validating a workflow_dispatch block. The three undocumented keys behave differently from what a reader might guess (for example options is only valid for choice inputs, and default for a choice input must be one of the listed options), so having them absent from the reference leads to trial-and-error. The dedicated workflow_dispatch event page (actions/using-workflows.../events-that-trigger-workflows / workflow-dispatch event doc) does cover these keys, so the gap is specifically the syntax reference page.

Suggested fix

Add the three subsections between the existing required and type subsections, in the same style:

  • on.workflow_dispatch.inputs.<input_id>.description: a string description of the input parameter.
  • on.workflow_dispatch.inputs.<input_id>.default: the default value used when the workflow is triggered manually without a value being supplied for the input.
  • on.workflow_dispatch.inputs.<input_id>.options: a list of strings containing the options shown in the dropdown list when the workflow is triggered manually; only usable when the input's type is choice.

Happy to open the corresponding PR once this issue is triaged.

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

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.