このページでは、ワークフロー自動化アクションカタログで利用可能なGitHubワークフロー実行アクションのリファレンスを提供します。これらのアクションを使用すると、ワークフロー定義から直接GitHub Actionsワークフロー実行をトリガー、取得、および一覧表示でき、カスタムコードや外部ツールを使用せずに、自動化されたCI/CDオーケストレーション、デプロイメントパイプライン、およびリリース自動化を実現できます。
前提条件
ワークフロー自動化でGitHubワークフロー実行アクションを使用する前に、以下が用意されていることを確認してください:
- ターゲットリポジトリへのアクセス権を持つGitHubアカウント。
- 必要な権限を持つGitHubパーソナルアクセストークン(PAT)。
- New Relic Secrets Serviceに保存されているPAT。
workflow_dispatchトリガーが設定されたターゲットワークフロー(gitHub.workflowRun.triggerに必要)。
PAT認証を設定する
GitHubワークフロー実行アクションは、Bearer資格情報として渡されるパーソナルアクセストークン(PAT)を使用して認証します。このアクションは、2つのトークンタイプをサポートしています:
- Fine-grained PAT —
gitHub.workflowRun.triggerにはActions: write権限、gitHub.workflowRun.get、gitHub.workflowRun.getLatest、およびgitHub.workflowRun.listにはActions: read権限が必要です。 - Classic PAT — 4つのアクションすべてでリポジトリスコープが必要です。
GitHub パーソナルアクセストークンを作成する
- GitHubで、Settings > Developer settings > Personal access tokensに移動します。
- Fine-grained tokens [Fine-grained トークン]またはTokens (classic) [トークン(クラシック)]を選択し、Generate new token [新しいトークンを生成]をクリックします。
- 必要な権限を設定してください。きめ細かいトークンの場合はActions: write(読み取り専用アクションの場合はActions: read)、クラシックトークンの場合はリポジトリスコープを設定します。
- 生成されたトークンをコピーしてください — GitHubでは1回のみ表示されます。
トークンをシークレットとして保存します
トークンをNew Relic Secrets Serviceに保存し、${{ :secrets:keyName }} 構文を使用してワークフローYAMLで参照してください:
token: ${{ :secrets:github-PAT-token }}利用可能なGitHubワークフロー実行アクション
次の表に、使用可能なGitHubワークフロー実行アクションと、そのリファレンスページへのリンクを示します。
アクション名 | 説明 |
|---|---|
| |
数値のRun IDを指定して、特定のワークフロー実行の詳細、ステータス、および結果を取得します。 | |
リポジトリのGitHub Actionsワークフロー実行を一覧表示します。オプションで、ワークフロー、ブランチ、イベント、ステータスなどでフィルタリングできます。 | |
特定のワークフローの最新のワークフロー実行を取得します。正確なRun IDが不明な場合に役立ちます。 |