注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。
ワークフローを手動実行する設定
ワークフローを手動で実行するには、workflow_dispatch
イベントで実行するようにワークフローを設定する必要があります。
workflow_dispatch
イベントをトリガーするには、ワークフローが既定のブランチに存在する必要があります。 workflow_dispatch
イベントの構成について詳しくは、「ワークフローをトリガーするイベント」をご覧ください。
これらのステップを実行するには、リポジトリへの書き込みアクセスが必要です。
ワークフローの実行
-
GitHub で、リポジトリのメイン ページに移動します。
-
リポジトリ名の下にある [アクション] をクリックします。
-
左側のサイド バーで、実行するワークフローの名前をクリックします。
-
ワークフロー実行の一覧の上にある [ワークフローの実行] ボタンをクリックします。
注: [ワークフローの実行] ボタンが表示されるには、ワークフロー ファイルで
workflow_dispatch
イベント トリガーが使われている必要があります。 [ワークフローの実行] ボタンを使ってワークフローを手動で実行できるのは、workflow_dispatch
イベント トリガーを使っているワークフロー ファイルだけです。workflow_dispatch
イベントの構成について詳しくは、「ワークフローをトリガーするイベント」をご覧ください。 -
[Branch] (ブランチ) ドロップダウン メニューを選択し、ワークフローを実行するブランチをクリックします。
-
ワークフローに入力が必要な場合は、フィールドに入力します。
-
[ワークフローの実行] をクリックします。
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
ワークフロー実行の進行状況を表示するには、run watch
サブコマンドを使用して、インタラクティブ リストから実行を選択します。
gh run watch
REST API を使用してワークフローを実行する
REST API を使用する場合は、要求本文パラメーターとして inputs
と ref
を構成します。 入力を省略すると、ワークフロー ファイルで定義されているデフォルト値が使用されます。
注: 1 つの workflow_dispatch
イベントに対して最大 10 個の inputs
を定義できます。
REST API の使用について詳しくは、「ワークフローの REST API エンドポイント」を参照してください。