パイプラインの開始条件

これらのオプションによって、パイプラインの開始条件を制御できます。パイプラインの開始を特定の条件に制限すると (プルリクエストが作成またはアップデートされた場合のみなど)、チームが使用するビルド時間数を削減できます。

パイプラインは、次のようなさまざまな条件下で開始するように設定できます。

コミットが任意のブランチにプッシュされたときに実行する — 既定の開始条件。
コミットが指定されたブランチにプッシュされたときに実行する — ブランチ開始条件。
プルリクエストが作成またはアップデートされ、指定されたブランチをターゲットにしたときに実行する — プルリクエスト開始条件。
git tag が作成されたときに実行する — タグ開始条件。
ユーザーにより手動で開始されたときに実行する — カスタム開始条件。

パイプラインの開始条件

Pipelines は、次のオプションを使用して条件付きで開始するように設定できます。

Pipelines プロパティ

pipelines プロパティは、リポジトリのビルドプロセスを定義するために使用されます。パイプラインの開始条件とパイプラインのステップが含まれます。pipelines プロパティは必須で、リポジトリごとに 1 回のみ定義する必要があります。

プロパティ — pipelines

必須 — はい

データタイプ — ブロック (YAML 仕様 - ブロックマッピング)

指定可能な親プロパティ — YAML ルート (pipelines は必ず最上位のプロパティとなります)

指定可能な子プロパティ — default、branches、pull-requests、tags、custom プロパティが 1 つ以上必要です。

例 — pipelines プロパティを使用して、基本的なパイプラインを作成する

pipelines:
  default:
    - step:
        name: Hello world example
        script:
          - echo "Hello, World!"

既定

他のセクションのパイプライン定義に一致しないすべてのブランチのパイプライン定義が含まれます。

ブランチ固有のパイプラインが定義されている場合を除き、既定のパイプラインはリポジトリへのプッシュ (タグプッシュは除く) のたびに実行されます。ブランチパイプラインは branch セクションで定義できます。

コミットをプッシュしてパイプラインのトリガーをスキップしたい場合は、[skip ci] または [ci skip] をコミットメッセージに追加できます。

プロパティ — default

必須 — いいえ

データタイプ — step、stage、または parallel プロパティのリスト (YAML 仕様 - シーケンス)

指定可能な親プロパティ — pipelines

指定可能な子プロパティ — step、stage、または parallel プロパティが 1 つ以上必要です。

例 — default プロパティを使用して、基本的なパイプラインを定義する

pipelines:
  default:
    - step:
        name: Hello world example
        script:
          - echo "Hello, World!"

例 — branches プロパティと default プロパティを併用する

次の例は、既定のパイプラインを定義し、hotfix/ がプレフィックス付けされたブランチにプッシュされた変更がないときに実行する方法を示しています。

pipelines:
  branches:
    hotfix/*:
      - step:
          name: Build hotfix branch
          script:
            - echo "Hello, hotfix!"
  default:
    - step:
        name: All other builds
        script:
          - echo "Hello, World!"

ブランチ

すべてのブランチ固有のビルドパイプラインを定義します。このセクションの名前または表現は、Git リポジトリのブランチと一致します。ブランチの照合に glob パターンを使用できます。glob パターンを使用してブランチ名を照合する方法の詳細については「Pipelines の yaml ファイルで glob パターンを使用する」をご確認ください。

コミットをプッシュしてパイプラインのトリガーをスキップしたい場合は、[skip ci] または [ci skip] をコミットメッセージに追加できます。

プロパティ — branches

必須 — いいえ

データタイプ — 改行で区切られた名前と値のペアのブロック (YAML 仕様 - ブロックマッピング)

指定可能な親プロパティ — pipelines

指定可能な子プロパティ — 内部でネストされた step、stage、または parallel 要素を使用した、候補のブランチ名を照合するユーザー定義の glob パターン

例 — branches プロパティを使用して、ブランチベースのパイプラインを定義する

リポジトリには、その bitbucket-pipelines.yml に次の Bitbucket Pipelines 構成があります。

image: node:lts
pipelines:
  default:
    - step:
        script:
          - echo "This script runs on all branches that don't have any specific pipeline assigned in 'branches'."
  branches:
    main:
      - step:
          script:
            - echo "This script runs only on commit to the main branch."
    feature/*:
      - step:
          image: openjdk:8 # This step uses its own image
          script:
            - echo "This script runs only on commit to branches with names that match the feature/* pattern."

main ブランチに基づく次の 2 つのブランチがリポジトリにプッシュされた場合

feature/BB-123-fix-links — 機能開発ブランチ
experimental — 実験的または革新的な変更を含むブランチ

各ブランチのルートディレクトリに同じ bitbucket-pipelines.yml ファイルがあります。ブランチにプッシュするたびに、Pipelines では bitbucket-pipelines.yml ファイルでブランチに割り当てられたスクリプトが実行されます。このファイルでは、

main ブランチパイプライン定義に、コミットが main ブランチにプッシュまたはマージされたときに実行する手順が含まれています。
feature/* ブランチ定義に、feature/BB-123-fix-links ブランチなど、feature/ がプレフィックス付けされた任意のブランチにコミットがプッシュされたときに実行する手順が含まれています。
default パイプライン定義に、experimental ブランチなど、main ではなく、feature/ がプレフィックス付けされていない任意のブランチへのコミット時に実行する手順が含まれています。

プルリクエスト

pull-requests プロパティは、プルリクエストが作成されたときのみ実行するパイプラインを定義します。実行前に宛先ブランチを作業ブランチにマージします。フォークされたリポジトリからのプルリクエストは、パイプラインをトリガーしません。マージが失敗すると、パイプラインが停止します。注意: 割り当てられたブランチは、プルリクエストのソースブランチである必要があります。

プルリクエストパイプラインは定義されている任意のブランチおよびデフォルトパイプラインに加えて実行されるため、定義が重複すると 2 つのパイプラインが同時に実行される場合があります。

構成にすでにブランチがあり、すべてのブランチをプルリクエストでのみ実行する場合は、キーワード branches を pull-requests に置き換えます。ブランチ名の照合に glob パターンを使用できます。glob パターンを使用してブランチ名を照合する方法の詳細については「Pipelines の yaml ファイルで glob パターンを使用する」をご確認ください。

コミットをプッシュしてパイプラインのトリガーをスキップしたい場合は、[skip ci] または [ci skip] をコミットメッセージに追加できます。

プロパティ — pull-requests

必須 — いいえ

データタイプ — 改行で区切られた名前と値のペアのブロック (YAML 仕様 - ブロックマッピング)

指定可能な親プロパティ — pipelines

例 — pull-requests プロパティを使用して、プルリクエストが作成されたときにパイプラインを実行する

pipelines:
  pull-requests:
    feature/*:
      - step:
          name: Build for feature branch pull request
          script:
            - echo "Hello, feature branch PR!"
    hotfix/*:
      - step:
          name: Build for hotfix branch pull request
          script:
            - echo "Hello, hotfix PR!"
    '**':
      - step:
          name: Build for all other pull requests
          script:
            - echo "Hello, non-feature, non-hotfix pull request!"

例 — pull-requests および default プロパティを使用して、プルリクエストベースのパイプラインと既定のパイプラインを定義する

次のパイプラインはどちらも、ブランチに hotfix/ がプレフィックス付けされている場合に実行されることにご注意ください。既定のパイプラインは任意のブランチ (hotfix/ がプレフィックス付けされたブランチを含む) がリポジトリにプッシュされたときに開始され、プルリクエストパイプラインはブランチを照合するためにプルリクエストが作成されたときに開始されます。

pipelines:
  pull-requests:
    hotfix/*:
      - step:
          name: Build for hotfix branch pull request
          script:
            - echo "Hello, hotfix PR!"
  default:
    - step:
        name: All other builds
        script:
          - echo "Hello, World!"

カスタム (手動) パイプライン

custom プロパティは、Bitbucket Cloud インターフェイスから手動またはスケジュール実行でのみトリガーできるパイプラインを定義します。手動またはスケジュールされたパイプラインの作成方法に関する詳細については「手動およびスケジュールされたパイプラインの作成」をご確認ください。

プロパティ — custom

必須 — いいえ

データタイプ — 改行で区切られた名前と値のペアのブロック (YAML 仕様 - ブロックマッピング)

指定可能な親プロパティ — pipelines

指定可能な子プロパティ — 内部でネストされた step、stage、parallel、または variables 要素を使用した、手動パイプラインの名前として使用されるユーザー定義の文字列

例 — custom プロパティを使用して、手動パイプライン「sonar」を定義する

pipelines:
  custom: # Pipelines that are triggered manually
    sonar: # The name that is displayed in the list in the Bitbucket Cloud GUI
      - step:
          script:
            - echo "Manual triggers for Sonar are awesome!"

例 — custom プロパティを使用して、2 つの手動パイプラインと 1 つの自動パイプラインを定義する

pipelines:
  custom: # Pipelines that are triggered manually
    sonar: # The name that is displayed in the list in the Bitbucket Cloud GUI
      - step:
          script:
            - echo "Manual triggers for Sonar are awesome!"
    deployment-to-prod: # Another display name
      - step:
          script:
            - echo "Manual triggers for deployments are awesome!"
  branches:  # Pipelines that run automatically on a commit to a branch
    staging:
      - step:
          script:
            - echo "Auto pipelines are cool too."

カスタム (手動) パイプライン変数

実行時に設定されるカスタムパイプライン変数は、custom パイプラインでのみ使用可能です。

カスタムパイプライン variables を使用すると、カスタムパイプラインの実行時に定義済みの変数を設定またはアップデートできます。各変数に名前が必要です。変数は、default 値と allowed-values のリストも保持できます。手動またはスケジュールされたパイプラインの作成方法に関する詳細については「手動およびスケジュールされたパイプラインの作成」をご確認ください。

シークレットとログイン認証情報は、漏洩を防ぐためにユーザー定義のパイプライン変数として保存する必要があります。詳細は「変数とシークレット — ユーザー定義の変数」をご参照ください。

プロパティ — variables

必須 — いいえ

データタイプ — キーと値のペアのリスト (YAML 仕様 - ブロックマッピング)

指定可能な親プロパティ — custom プロパティ内にネストされた手動パイプライン名

指定可能な子プロパティ — name、default、allowed-values、description

プロパティ	必須またはオプション	説明	データタイプ
`name`	必須	変数の名前。`$Username` を使用して構成で `name: Username` が参照されるなど、パイプライン構成の変数を参照するために使用されます。	文字列
`default`	任意	変数の既定値。変数がパイプラインの実行時に手動で設定されない場合に、この値が使用されます。実行時に設定できない変数を定義するには、ユーザー定義変数を使用します。	文字列
`allowed-values`	任意	変数に指定可能な値のリスト。	文字列のリスト (YAML 仕様 - シーケンス)
`description`	任意	ユーザーがプロパティにどのような値を追加すべきかを知るのに役立つ具体的な情報や簡単な要約を提供します。	文字列

例 — variables プロパティを使用して、カスタムパイプライン変数を定義する

pipelines:
  custom: # Pipelines that are triggered manually
    us-build: # The name that is displayed in the list in the Bitbucket Cloud GUI
      - variables:
          - name: Username
          - name: Role
            default: "admin"          # optionally provide a default variable value
            description: "Add user role"
          - name: Region
            default: "us-east-1"
            allowed-values:           # optionally restrict variable values
              - "ap-southeast-2"
              - "us-east-1"
              - "us-west-2"
      - step:
          script:
            - echo "$Username manually triggered for a build for $Region as $Role!"

トリガープロパティ

triggers プロパティを使用すると、1 つのイベントから複数のパイプラインを並行してトリガーできる条件ベースのルールを定義できます。ブランチ、タグ、またはプルリクエストを使用して単一のパイプラインを選択する従来のセレクターベースのアプローチとは異なり、トリガーは論理式を使用して実行するパイプラインを決定するため、より柔軟で強力な構成が可能になります。

トリガープロパティを使用すると、次のことが可能になります。

単一のイベントから独立してパイプラインを並列に実行する
論理式を使用して複雑な条件を設定する
単一のイベントから複数のパイプラインをトリガーする
大規模でモノリシックなパイプラインを、焦点を絞った小さなパイプラインに分離する

プロパティ — triggers

必須 — いいえ

データタイプ — ブロック (YAML 仕様 - ブロックマッピング)

指定可能な親プロパティ — YAML ルート (triggers は必ず最上位のプロパティとなります)

指定可能な子プロパティ — 条件定義リストがネストされたトリガータイプ。

例 — トリガープロパティを使用して、「main」ブランチがプッシュされたときに 2 つのパイプラインが実行されるように構成します。

triggers:
  repository-push:
    - condition: BITBUCKET_BRANCH == "main"
      pipelines:
        - pipeline1
        - pipeline2

この例では、コミットが main ブランチにプッシュされるときに pipeline1 と pipeline2 の両方を並行して実行します。

例 — triggers プロパティを使用して、「main」ブランチでプルリクエストが作成またはアップデートされたときに 2 つのパイプラインが実行されるように構成します。

triggers:
  pullrequest-push:
    - condition: BITBUCKET_BRANCH == "main"
      pipelines:
        - pipeline1
        - pipeline2

この例では、main ブランチを含むプルリクエストが作成または更新されたときに、両方のパイプラインを実行します。

トリガーのタイプ

トリガータイプは、Bitbucket に関連条件を評価させるリポジトリイベント (プッシュまたはプルリクエストのアップデートなど) を指定します。条件が true と評価されると、指定されたパイプラインが実行されます。

サポートされるトリガータイプ。

repository-push
コミットが任意のブランチにプッシュされたとき、または git tag が作成されたときに評価されます。
pullrequest-push
プルリクエストが作成またはアップデートされたときに評価されます。

今後のリリースでは、その他のトリガータイプがサポートされる可能性があります。

必須 — いいえ

データタイプ — 文字列

指定可能な値 — repository-push、pullrequest-push

指定可能な親プロパティ — triggers

指定可能な子プロパティ — condition、pipelines

条件

condition プロパティは、指定されたパイプラインをトリガーする必要があるかどうかを判断するために実行時に評価される論理式を定義します。条件ではパイプライン変数を使用でき、論理演算子により柔軟な一致をサポートします。

プロパティ — condition

必須 — はい

データタイプ — 文字列

指定可能な親プロパティ — triggers 内でトリガータイプの下にネストされる必要があります。

指定可能な子プロパティ — なし

例 – プルリクエストが作成またはアップデートされたときにパイプラインをトリガーします。ソースブランチは「feature/test」、宛先ブランチは「main」です。

pipelines:
  custom:
    pipeline1:
      - step:
          name: Test
          script:
            - echo "Hello, World!"
triggers:
  pullrequest-push:
    - condition: BITBUCKET_BRANCH == "feature/test" && BITBUCKET_PR_DESTINATION_BRANCH == "main"
      pipelines:
        - pipeline1

この例では、プルリクエストが feature/test ブランチから main ブランチに作成または更新された場合にのみ pipeline1 がトリガーされます。

Pipelines

pipelines プロパティは、関連付けられた条件が true と評価されたときにトリガーされるパイプラインを指定します。リストされているすべてのパイプラインは並列に開始されます。

注: トリガーで参照できるのは、YAML ファイルの custom セクションで定義されたパイプラインのみです。このリスト内の各パイプライン名が、定義したカスタムパイプラインと一致していることを確認してください。カスタムパイプラインの詳細については、こちらをお読みください

プロパティ — pipelines

必須 — はい

データタイプ — 文字列のリスト (YAML 仕様 - シーケンス)

指定可能な親プロパティ - triggers のトリガータイプ内の条件の下にネストされる必要があります

指定可能な子プロパティ — なし

例 – コミットが「main」ブランチにプッシュされたときに 2 つのパイプラインを並行してトリガーします。

pipelines:
  custom:
    pipeline1:
      - step:
          name: Test
          script:
            - echo "Hello, World!"
    pipeline2:
      - step:
          name: Test
          script:
            - echo "Hello, World!"
triggers:
  repository-push:
    - condition: BITBUCKET_BRANCH == "main"
      pipelines:
        - pipeline1
        - pipeline2

この例では、コミットが main ブランチにプッシュされるときに pipeline1 と pipeline2 の両方を並行して実行します。

トリガー条件の記述

トリガー条件は、論理式を使用して、特定のイベントに対してどのパイプラインを実行するかを決定します。各条件は、使用可能なパイプライン変数を使用して実行時に評価されます。条件が true と評価されると、関連するパイプラインが実行されます。

条件式では、次の変数を使用できます。

BITBUCKET_BRANCHE — イベントのブランチの名前。
BITBUCKET_TAG — イベントのタグの名前。
BITBUCKET_PR_DESTINATION_BRANCH — プルリクエストの宛先ブランチ。
BITBUCKET_PR_DESTINATION_COMMIT — プルリクエストの宛先のコミットハッシュ。
BITBUCKET_PR_ID — プルリクエストの ID。
すべての非セキュアワークスペース変数とリポジトリ変数

ガイドライン:

条件式では変数は引用符なしで表記する必要があります (例: BITBUCKET_BRANCH)。
文字列リテラルは引用符で囲む必要があります (例:"main")。
ブール値と数値がサポートされており、引用符なしで表記されます。
すべての比較では大文字と小文字が区別されます。
変数は大文字と小文字を区別し、このように使用する必要があります。

サポートされる演算子:

== — 等式
!= — 不等式
&& — 論理 AND
|| — 論理 OR
! — 論理 NOT
() — グループ化
>, >=, <, <= — 比較演算子
glob(value, pattern) — glob 構文を使用したパターンマッチング

例：

単純等式:
condition: BITBUCKET_BRANCH == "main"
ブランチが「main」と一致するときに実行されます。
Glob パターンマッチング:
condition: glob(BITBUCKET_BRANCH, "feature/*")
「feature/」で始まる任意のブランチに対して実行されます。
複雑な論理式:
condition: BITBUCKET_BRANCH == "main" && BITBUCKET_PR_DESTINATION_BRANCH == "production"
ブランチが「main」で PR の宛先が「production」の場合に実行されます。
OR の使用:
condition: BITBUCKET_BRANCH == "integration" || BITBUCKET_PR_DESTINATION_BRANCH == "main"
ブランチが「integration」、または PR の宛先が「main」の場合に実行されます。
NOT の使用:
condition: !(glob(BITBUCKET_BRANCH, "feature/*") || BITBUCKET_BRANCH == "main")
「main」ではなく、「feature/*」と一致しないブランチに対して実行されます。

glob() 関数

glob() 関数により、トリガー条件での柔軟なパターンマッチングが可能になり、ワイルドカードと中括弧の展開を使用して、ブランチ、タグ、またはその他の変数を一致させることができます。値がパターンと一致する場合は true を返し、それ以外の場合は false を返します。

構文とパラメーター

構文: glob(value, "pattern")

value: テストする変数 (例えば、BITBUCKET_BRANCH、BITBUCKET_TAG)
pattern: 一致する glob パターン (引用符で囲む必要があります。*、?、などのワイルドカードおよび、{} などの中括弧拡張をサポートします。パターンでは大文字と小文字が区別されます)

動作

glob() 関数は、Pipelines yaml ファイルで glob パターンを使用する場合と同じパターンマッチングルールに従います。

条件式では glob() と論理演算子 (&&、||、!) を組み合わせて高度な一致を行うことができます。

例：

フィーチャーブランチとの一致:
glob(BITBUCKET_BRANCH, "feature/*")
「feature/」で始まるすべてのブランチに一致します。
バージョンタグとの一致:
glob(BITBUCKET_TAG, "v1.*")
「v1.0」、「v1.1」などのタグに一致します
中括弧拡張を使用した複数パターンとの一致:
glob(BITBUCKET_BRANCH, "{main,develop,staging}")
ブランチが「main」、「develop」、「staging」のいずれかである場合に一致します。
glob ** によるすべてとの一致:
glob(BITBUCKET_BRANCH,　"**")
任意のブランチ名と一致します。

トリガーと従来のセレクターとの違い

Aspect	従来のセレクター (ブランチ、タグなど)	トリガー
一致の動作	最初に一致したパイプラインのみが実行される	一致したパイプラインはすべて並行して実行される
複数のパイプライン	イベントごとに実行できるパイプラインは 1 つだけ	イベントごとに複数のパイプラインを実行可能
条件の複雑さ	基本的なパターンマッチング	論理式と高度なパターンマッチング (glob、AND/OR/NOT)

重要: トリガーは従来のセレクターと累積されます。従来のセレクターとトリガーの両方が一致すると、両方のパイプラインが実行されます。

トリガーの制限事項

トリガーには次の制限が適用されます。

YAML ファイルあたりトリガータイプ 1 つにつき最大 20 条件 (たとえば、repository-push につき最大 20、pullrequest-push につき最大 20)。
1 つのイベントから最大 100 のパイプラインを (一致するすべての条件とトリガータイプにわたって) トリガーできます。
トリガーで参照されるすべてのパイプラインは、YAML ファイルのカスタムセクションで定義する必要があります。
インポートされたパイプラインはサポートされています (例: YAML インポート経由で含められたパイプライン) が、カスタムパイプラインで定義する必要があります。

この内容はお役に立ちましたか?

正確ではなかった明確ではなかった関係なかった

さらにヘルプが必要ですか?

アトラシアンコミュニティをご利用ください。

コミュニティに質問

Bitbucket サポート

パイプラインの開始条件

パイプラインの開始条件

Pipelines プロパティ

例 — pipelines プロパティを使用して、基本的なパイプラインを作成する

既定

例 — default プロパティを使用して、基本的なパイプラインを定義する

例 — branches プロパティと default プロパティを併用する

ブランチ

例 — branches プロパティを使用して、ブランチベースのパイプラインを定義する

プルリクエスト

例 — pull-requests プロパティを使用して、プルリクエストが作成されたときにパイプラインを実行する

例 — pull-requests および default プロパティを使用して、プルリクエストベースのパイプラインと既定のパイプラインを定義する

Tags

例 — tags プロパティを使用して、タグベースのパイプラインを定義する

例 — tags および default プロパティを使用して、タグベースのパイプラインと既定のパイプラインを定義する

カスタム (手動) パイプライン

例 — custom プロパティを使用して、手動パイプライン「sonar」を定義する

例 — custom プロパティを使用して、2 つの手動パイプラインと 1 つの自動パイプラインを定義する

カスタム (手動) パイプライン変数

例 — variables プロパティを使用して、カスタムパイプライン変数を定義する

トリガープロパティ

トリガーのタイプ

サポートされるトリガータイプ。

条件

Pipelines

トリガー条件の記述

サポートされる演算子:

glob() 関数

構文とパラメーター

動作

例：

トリガーと従来のセレクターとの違い

トリガーの制限事項

さらにヘルプが必要ですか?

パイプラインの開始条件

パイプラインの開始条件

Pipelines プロパティ

例 — pipelines プロパティを使用して、基本的なパイプラインを作成する

既定

例 — default プロパティを使用して、基本的なパイプラインを定義する

例 — branches プロパティと default プロパティを併用する

ブランチ

例 — branches プロパティを使用して、ブランチベースのパイプラインを定義する

プル リクエスト

例 — pull-requests プロパティを使用して、プル リクエストが作成されたときにパイプラインを実行する

例 — pull-requests および default プロパティを使用して、プル リクエストベースのパイプラインと既定のパイプラインを定義する

Tags

例 — tags プロパティを使用して、タグベースのパイプラインを定義する

例 — tags および default プロパティを使用して、タグベースのパイプラインと既定のパイプラインを定義する

カスタム (手動) パイプライン

例 — custom プロパティを使用して、手動パイプライン「sonar」を定義する

例 — custom プロパティを使用して、2 つの手動パイプラインと 1 つの自動パイプラインを定義する

カスタム (手動) パイプライン変数

例 — variables プロパティを使用して、カスタム パイプライン変数を定義する

トリガー プロパティ

トリガーのタイプ

サポートされるトリガー タイプ。

条件

Pipelines

トリガー条件の記述

サポートされる演算子:

glob() 関数

構文とパラメーター

動作

例：

トリガーと従来のセレクターとの違い

トリガーの制限事項

さらにヘルプが必要ですか?

プルリクエスト

例 — pull-requests プロパティを使用して、プルリクエストが作成されたときにパイプラインを実行する

例 — pull-requests および default プロパティを使用して、プルリクエストベースのパイプラインと既定のパイプラインを定義する

例 — variables プロパティを使用して、カスタムパイプライン変数を定義する

トリガープロパティ

サポートされるトリガータイプ。