workflow_dispatchによる手動トリガー
workflow_dispatchでカスタム入力付きの手動トリガーGitHub Actionsワークフローを作成。入力タイプ（string、boolean、choice）、デフォルト値、条件ロジックを解説。
Advanced
詳細な説明
workflow_dispatchによる手動ワークフロー
workflow_dispatchトリガーは、GitHub UI、API、またはCLIからワークフローを手動で実行できます。フォームフィールドとして表示されるカスタム入力を定義でき、特定の環境へのデプロイやデータマイグレーションなどの一回限りのタスクに最適です。
入力タイプ
| タイプ | 説明 | UI要素 |
|---|---|---|
string |
自由形式テキスト入力 | テキストフィールド |
boolean |
True/falseトグル | チェックボックス |
choice |
定義済みオプションから選択 | ドロップダウン |
environment |
GitHub環境を選択 | 環境ピッカー |
トリガー方法
- GitHub UI: Actionsタブ > ワークフローを選択 > 「Run workflow」をクリック
- GitHub CLI:
gh workflow run deploy.yml -f environment=staging -f version=v1.2.3 - API:
POST /repos/{owner}/{repo}/actions/workflows/{id}/dispatches
ステップでの入力の使用
${{ inputs.name }}で入力にアクセスします。入力はこの方法でアクセスすると常に文字列です。ブール値の比較には${{ inputs.dry-run == true }}を使用します。
ユースケース
手動プロダクションデプロイ、オンデマンドデータベースマイグレーション、一回限りのデータ処理タスク、または実行前に人間の判断が必要なあらゆる操作。CIとCDを手動承認ゲートで分離するチームで一般的です。