GitHubのワークフロー実行をトリガーします。

workflow_dispatchイベントを介してGitHub Actionsワークフローの実行をトリガーします。ターゲットワークフローには、workflow_dispatchトリガーが構成されている必要があります。成功すると、GitHubはHTTP 204 No Contentを返します。

認証の設定については、GitHubワークフロー実行アクションをご覧ください。

このアクションでは、以下の入力を使用できます。

入力	タイプ	説明	例
token	弦	必須。シークレットとして保存されたGitHub Personal Access トークンです。Fine-grained PATには、Actions: write権限が必要です。Classic PATには、リポジトリスコープが必要です。	`"${{ :secrets:github-PAT-token }}"`
owner	弦	必須。リポジトリのアカウント所有者（ユーザーまたは組織のログイン）。大文字と小文字は区別されません。	`"octocat"`
repo	弦	必須。.gitを含まないリポジトリ名サフィックス。大文字と小文字は区別されません。	`"Hello-World"`
workflowId	弦	必須。ワークフローのファイル名、または数値のワークフローID。	`"deploy.yml"`
ref	弦	必須。ワークフローを実行するgitリファレンス（ブランチまたはタグ）です。リポジトリに存在する必要があります。	`"main"`
入力	地図	オプション。ワークフローの`workflow_dispatch`トリガーで定義されたキーの値の入力パラメーター。すべての値は文字列である必要があります。空の場合、リクエストから省略されます。	`{"environment": "staging", "version": "1.2.3"}`
selectors	リスト	オプション。レスポンスから値を抽出するためのJQセレクター。	`[{"name": "runId", "expression": ".workflow_run_id"}]`

このアクションは、以下の出力を返します。

出力	タイプ	例
response	オブジェクト	`{ "workflow_run_id": 1, "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" }`
success	ブール値	`success: true \| false`
errorMessage	弦	GitHub APIのエラーレスポンス本文が含まれます。一般的なエラー：404（リポジトリまたはワークフローが見つからない）、422（参照が存在しない、または`workflow_dispatch`イベントが構成されていない）。

ワークフローの例
`name: trigger_github_workflow description: Trigger a GitHub Actions workflow run steps: - name: trigger_run type: action action: gitHub.workflowRun.trigger version: 1 inputs: token: ${{ :secrets:github-PAT-token }} owner: your_user_name repo: test-workflow workflowId: deploy.yml ref: main inputs: environment: staging version: "1.2.3" next: end`

ワークフローの例

name: trigger_github_workflow
description: Trigger a GitHub Actions workflow run
steps:
  - name: trigger_run
    type: action
    action: gitHub.workflowRun.trigger
    version: 1
    inputs:
      token: ${{ :secrets:github-PAT-token }}
      owner: your_user_name
      repo: test-workflow
      workflowId: deploy.yml
      ref: main
      inputs:
        environment: staging
        version: "1.2.3"
    next: end

この機械翻訳は、参考として提供されています。

GitHubのワークフロー実行をトリガーします。