5.2. パイプライン実行仕様の動的変数
パイプライン実行仕様で動的変数を使用すると、パイプライン実行をトリガーしたコミットに関する情報を提供したり、GitHub API 操作に一時的な GitHub App トークンを使用したりできます。
現在、パイプラインまたはタスクパラメーターのデフォルト値に Pipelines as Code お動的変数を使用することはサポートされていません。動的変数は value:
フィールドで使用できますが、default:
フィールドでは使用できません。
5.2.1. コミットと URL 情報 リンクのコピーリンクがクリップボードにコピーされました!
{{<var>}}
形式の動的かつ拡張可能な変数を使用して、コミットと URL のパラメーターを指定できます。現在、以下の変数を使用できます。
-
{{repo_owner}}
: リポジトリーの所有者。 -
{{repo_name}}
: リポジトリー名。 -
{{repo_url}}
: リポジトリーの完全な URL。 -
{{revision}}
: コミットの完全 SHA リビジョン。 -
{{sender}}
: コミットの送信者のユーザー名またはアカウント ID。 -
{{source_branch}}
: イベントが発生したブランチ名。 -
{{target_branch}}
: イベントが対象とするブランチ名。push イベントの場合は、source_branch
と同じです。 -
{{pull_request_number}}
:pull_request
イベントタイプに対してのみ定義されたプルまたはマージリクエスト番号。 -
{{git_auth_secret}}
: プライベートリポジトリーをチェックアウトするための Git プロバイダートークンで自動的に生成されるシークレット名。
5.2.2. GitHub API 操作用の一時的な GitHub App トークン リンクのコピーリンクがクリップボードにコピーされました!
GitHub App から Pipelines as Code によって生成された一時インストールトークンを使用して、GitHub API にアクセスできます。GitHub App は git-provider-token
キーでプライベートリポジトリーのキーを生成します。このキーにアクセスするには、パイプライン実行で {{git_auth_secret}}
動的変数を使用できます。
たとえば、パイプライン実行がプルリクエストにコメントを追加する必要がある場合は、Pipelines as Code アノテーションを使用して、Tekton Hub から github-add-comment
タスク定義を取得し、次の例に示すように、コメントを追加するタスクを定義できます。
- 1
- 動的変数を使用することで、Pipelines as Code で使用する任意のリポジトリーからの任意のプルリクエストに対してこのスニペットテンプレートを再利用できます。
GitHub App では、生成されたインストールトークンは 8 時間利用可能で、イベントが発生したリポジトリーのみに適用されます。スコープは異なる方法で設定できますが、有効期限は GitHub によって決定されます。