Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

5.4. イベントのパイプライン実行と照合するためのアノテーション

パイプライン実行時にアノテーションを使用することで、各パイプライン実行と、異なる Git プロバイダーイベントをマッピングできます。イベントトガッチする複数のパイプライン実行がある場合に、Pipelines as Code はそれらを並行して実行し、パイプライン実行の終了直後に結果を Git プロバイダーに通知します。

5.4.1. プルリクエストイベントとパイプライン実行とのマッチング処理
リンクのコピー

次の例を使用して、main ブランチを対象とする pull_request イベントと、pipeline-pr-main パイプライン実行を一致させることができます。 

apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  name: pipeline-pr-main
annotations:
  pipelinesascode.tekton.dev/on-target-branch: "[main]"
1 

  pipelinesascode.tekton.dev/on-event: "[pull_request]"
# ...
Copy to Clipboard Toggle word wrap
1
コンマ区切りのエントリーを追加して、複数のブランチを指定できます。たとえば、"[main, release-nightly]" です。さらに、以下の項目を指定できます。
  • "refs/heads/main" などのブランチへの完全な参照
  • "refs/heads/\*" などのパターン照合を含む glob
  • "refs/tags/1.\*" などのタグ

5.4.2. プッシュイベントのパイプライン実行との照合
リンクのコピー

次の例を使用して、pipeline-push-on-main パイプライン実行を refs/heads/main ブランチを対象とする push イベントと一致させることができます。 

apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  name: pipeline-push-on-main
annotations:
  pipelinesascode.tekton.dev/on-target-branch: "[refs/heads/main]"
1 

  pipelinesascode.tekton.dev/on-event: "[push]"
# ...
Copy to Clipboard Toggle word wrap
1
コンマ区切りのエントリーを追加して、複数のブランチを指定できます。たとえば、"[main, release-nightly]" です。さらに、以下の項目を指定できます。
  • "refs/heads/main" などのブランチへの完全な参照
  • "refs/heads/\*" などのパターン照合を含む glob
  • "refs/tags/1.\*" などのタグ

5.4.3. コメントイベントのパイプライン実行へのマッチング処理
リンクのコピー

重要

コメントイベントをパイプライン実行に一致させる機能は、テクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

次の例を使用すると、コメントのテキストが ^/merge-pr 正規表現と一致する場合に、pipeline-comment パイプライン実行をプルリクエストのコメントと一致させることができます。 

apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  name: pipeline-comment
annotations:
  pipelinesascode.tekton.dev/on-comment: "^/merge-pr"
# ...
Copy to Clipboard Toggle word wrap

パイプラインの実行は、コメント作成者が次のいずれかの要件を満たしている場合にのみ開始されます。

  • 作成者がリポジトリーの所有者である。
  • 作成者がリポジトリーのコラボレーターである。
  • 作成者がリポジトリーの組織のパブリックメンバーである。
  • コメントの作成者が Kubernetes ドキュメント で定義されているように、リポジトリーのルートにある OWNERS ファイルの approvers または reviewers のセクションにリストされている。Pipelines as Code は OWNERS および OWNERS_ALIASES ファイルの仕様をサポートします。OWNERS ファイルに フィルター セクションが含まれている場合、Pipelines as Code は approvers と reviewers を .* フィルターに対してのみ照合します。

5.4.4. 高度なイベントマッチング処理
リンクのコピー

Pipelines as Code は、高度なイベントマッチング処理のために Common Expression Language (CEL) ベースのフィルタリングの使用をサポートします。パイプラインの実行に pipelinesascode.tekton.dev/on-cel-expression アノテーションがある場合に、Pipelines as Code は CEL 式を使用し、on-target-branch アノテーションをスキップします。単純な on-target-branch アノテーションのマッチング処理と比較して、CEL 式では複雑なフィルタリングと否定が可能です。

重要

on-cel-expression アノテーションを、on-event、on-target-branch、on-label、on-path-change、または on-path-change-ignore アノテーションと同じパイプライン実行内で使用すると、on-cel-expression アノテーションが優先され、Pipelines as Code は他のアノテーションを無視します。

Pipelines as Code で CEL ベースのフィルタリングを使用するには、次のアノテーションの例を検討してください。

  • main ブランチを対象とし、wip ブランチからの pull_request イベントを一致させるには、次のようにします。 

    apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  name: pipeline-advanced-pr
annotations:
  pipelinesascode.tekton.dev/on-cel-expression: |
    event == "pull_request" && target_branch == "main" && source_branch == "wip"
...
    Copy to Clipboard Toggle word wrap

  • パスが変更された場合にのみパイプラインを実行するには、glob パターンで .pathChanged 接尾辞関数を使用できます。 

    apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  name: pipeline-advanced-pr-pathchanged
annotations:
  pipelinesascode.tekton.dev/on-cel-expression: |
    event == "pull_request" && "docs/\*.md".pathChanged()
    1 
    
# ...
    Copy to Clipboard Toggle word wrap
    1
    docs ディレクトリー内のすべてのマークダウンファイルと一致します。

  • [DOWNSTREAM] で始まるすべてのプルリクエストとマッチさせるには、以下を実行します。 

    apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  name: pipeline-advanced-pr-downstream
annotations:
  pipelinesascode.tekton.dev/on-cel-expression: |
    event == "pull_request && event_title.startsWith("[DOWNSTREAM]")
# ...
    Copy to Clipboard Toggle word wrap

  • pull_request イベントでパイプラインを実行し、experimental ブランチを省略するには、以下を実行します。 

    apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  name: pipeline-advanced-pr-not-experimental
annotations:
  pipelinesascode.tekton.dev/on-cel-expression: |
    event == "pull_request" && target_branch != experimental"
# ...
    Copy to Clipboard Toggle word wrap

Pipelines as Code を使用しながら高度な CEL ベースのフィルタリングを行うには、次のフィールドと接尾辞関数を使用できます。

  • event: push または pull_request イベント。
  • target_branch: ターゲットブランチ。
  • source_branch: 元の pull_request イベントのブランチ。push イベントの場合は、target_branch と同じです。
  • event_title: push イベントのコミットタイトルや、pull_request イベントのプルまたはマージリクエストのタイトルなど、イベントのタイトルとマッチします。現在、サポートされているプロバイダーは GitHub、Gitlab、および Bitbucket Cloud のみです。
  • .pathChanged: 文字列への接尾辞関数です。文字列は、パスが変更されたかどうかを確認するパスの glob にすることができます。現在、GitHub と Gitlab のみがプロバイダーとしてサポートされています。

さらに、Git リポジトリープロバイダーによって渡された完全なペイロードにアクセスできます。headers フィールドを使用して、ペイロードのヘッダー (headers['x-github-event'] など) にアクセスします。body フィールドを使用して、ペイロードの本文 (body.pull_request.state など) にアクセスします。

重要

Pipelines as Code による CEL ベースのフィルタリングにペイロードのヘッダーと本文を使用するのは、テクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

次の例では、次の条件がすべて満たされる場合にのみパイプラインの実行が開始します。

  • プルリクエストは main ブランチをターゲットとしています。
  • プルリクエストの作成者は superuser です。
  • アクションは synchronize です。このアクションは、プルリクエストで更新が発生したときにトリガーされます。 
apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  annotations:
    pipelinesascode.tekton.dev/on-cel-expression: |
      body.pull_request.base.ref == "main" &&
        body.pull_request.user.login == "superuser" &&
        body.action == "synchronize"
# ...
Copy to Clipboard Toggle word wrap
注記

イベントの一致に header または body フィールドを使用する場合は、retest などの Git コマンドを使用してパイプラインの実行をトリガーできない可能性があります。Git コマンドを使用する場合、ペイロード本体は元のペイロードではなく、このコマンドを含むコメントになります。

イベントのマッチング処理に body フィールドを使用するときにパイプライン実行を再度トリガーする場合は、プルリクエストを終了し、再度開くか、または要求をマージするか、新しい SHA コミットを追加できます。次のコマンドを使用して、新しい SHA コミットを追加できます。 

git commit --amend --no-edit && git push --force-with-lease
Copy to Clipboard Toggle word wrap
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat