ワークフローを手動実行する設定
ワークフローを手動で実行するには、workflow_dispatch イベントで実行するようにワークフローを設定する必要があります。 workflow_dispatchイベントの設定に関する詳しい情報については「ワークフローをトリガーするイベント」を参照してください。
GitHub でワークフローを実行する
GitHub で workflow_dispatch イベントをトリガーするには、ワークフローがデフォルトブランチに含まれている必要があります。 ワークフローの実行を手動でトリガーするには、次の手順に従います。
これらのステップを実行するには、リポジトリへの書き込みアクセスが必要です。
- GitHubで、リポジトリのメインページにアクセスしてください。
- リポジトリ名の下でActions（アクション）をクリックしてください。
- 左側のサイドバーで、実行するワークフローをクリックします。
- ワークフロー実行の一覧の上にあるRun workflow（ワークフローの実行）を選択します。
- ワークフローを実行するブランチを選択し、ワークフローで使用される入力パラメータを入力します。 Run workflow（ワークフローの実行）をクリックします。
GitHub CLI を使ってワークフローを実行する
GitHub CLIのセットアップに関する情報については「GitHub CLIでのGitHub Actionsの管理」を参照してください。
ワークフローを実行するには、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 [email protected]標準入力を使用して、入力を JSON として渡すこともできます。
echo '{"name":"mona", "greeting":"hello"}' | gh workflow run greet.yml --jsonリポジトリのデフォルトブランチ以外のブランチでワークフローを実行するには、--ref フラグを使用します。
gh workflow run workflow --ref branch-nameワークフロー実行の進行状況を表示するには、run watch サブコマンドを使用して、インタラクティブリストから実行を選択します。
gh run watchREST API を使用してワークフローを実行する
REST API を使用する場合は、 inputsとrefをリクエストボディのパラメータとして設定してください。 入力を省略すると、ワークフロー ファイルで定義されているデフォルト値が使用されます。
REST API の使用の詳細については、「ワークフローディスパッチ イベントの作成」を参照してください。