Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

workflow_dispatch inputs: description, default and options are not documented

オープン 初心者向け
  • 何か問題がありますか？
#46,299 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@kburym がすでに取り組んでいます。

2026年10月13日 から。

  • #46300 @kburym による — オープン

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
80/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
github-actions
領域
documentation

調査の方向性

ワークフロー構文の記事にある on.workflow_dispatch.inputs.<input_id> のセクションには、required と type しか記載されていません。actions/languageservices の workflow-parser/src/workflow-v1.0.json にある workflow_dispatch の入力定義を読み、description、default、options の意味を確認してください。使用例は data/reusables/actions/workflow-dispatch-inputs-example.md を確認してください。各キーに短いサブセクションがあり、options が choice 入力にのみ適用されると書かれていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
TypeScript
スター
21k
フォーク
69.1k
平均マージ
6時間 37分
マージ済み PR（30日）
109

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

github/docs のほかの issue

github/docs の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。