注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。
ワークフローを手動実行する設定
ワークフローを手動で実行するには、workflow_dispatch
イベントで実行するようにワークフローを設定する必要があります。 workflow_dispatch
イベントをトリガーするには、ワークフローが既定のブランチに存在する必要があります。 workflow_dispatch
イベントの構成の詳細については、「ワークフローをトリガーするイベント」を参照してく� さい。
これらのステップを実行するには、リポジトリへの書き込みアクセスが必要です。
ワークフローの実行
- で、リポジトリのメイン ページへ移動します。 1. リポジトリ名の下の [Actions] (アクション) をクリックします。
- 左のサイドバーで、実行したいワークフローをクリックしてく� さい。
- ワークフロー実行の一覧の上にある [ワークフローの実行] を選択します。
- [分岐] ドロップダウンを使用してワークフローのブランチを選択し、入力パラメーターを入力します。 [ワークフローの実行] をクリックします。
GitHub CLI の詳細については、「GitHub CLI について」を参照してく� さい。
ワークフローを実行するには、workflow run
サブコマンドを使用します。 workflow
パラメーターを、実行するワークフローの名前、ID、またはファイル名のいずれかに置き換えます。 たとえば、「"Link Checker"
」、「1234567
」、「"link-check-test.yml"
」のように指定します。 ワークフローを指定しない� �合、GitHub CLI はワークフローを選択するためのインタラクティブメニューを返します。
gh workflow run workflow
ワークフローに入力可能な� �合、GitHub CLI は入力を求めるプロンプトを表示します。 または、-f
または -F
を使用して key=value
形式の入力を追� できます。 -F
を使用してファイルから読み取ります。
gh workflow run greet.yml -f name=mona -f greeting=hello -F data=@myfile.txt
標準入力を使用して、入力を JSON として渡すこともできます。
echo '{"name":"mona", "greeting":"hello"}' | gh workflow run greet.yml --json
リポジトリの既定のブランチ以外のブランチでワークフローを実行するには、--ref
フラグを使用します。
gh workflow run workflow --ref branch-name
ワークフロー実行の進行状況を表示するには、run watch
サブコマンドを使用して、インタラクティブ リストから実行を選択します。
gh run watch
REST API を使用してワークフローを実行する
REST API を使用する� �合は、要求本文パラメーターとして inputs
と ref
を構成します。 入力を省略すると、ワークフロー ファイルで定義されているデフォルト値が使用されます。
注: 1 つの workflow_dispatch
イベントに対して最大 10 個の inputs
を定義できます。
REST API の使用の詳細については、「ワークフロー ディスパッチ イベントの作成」を参照してく� さい。