Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#46,354 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
1-3 heures
Accessibilité débutants
88/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
github-actions, yaml
Domaine
documentation

Piste de recherche

Commencez par content/actions/reference/workflows-and-actions/workflow-syntax.md et trouvez la section on.workflow_dispatch.inputs.<input_id>, en particulier les sous-sections existantes required et type. Ajoutez des sous-sections correspondantes pour description, default et options, y compris les contraintes de choice décrites dans l’issue. Le travail est terminé lorsque les trois clés sont documentées à cet endroit dans l’ordre et le style suggérés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
TypeScript
Étoiles
21k
Forks
69.1k
Merge moyen
10 h 32 min
PR mergées (30 j)
103

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de github/docs

Toutes les issues de github/docs

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.