ビルドトリガーについて
ビルドトリガーを使用すると、1つ以上のBitriseビルドを自動的に開始できます。トリガーの定義には、コードイベントと、そのイベントがビルドをトリガーするために満たす必要がある1つ以上の条件が含まれます。
トリガーはWorkflowまたはPipeline内で定義できます。これにより、単一のコードイベントで複数の異なるWorkflowsやPipelinesをトリガーできるため、すべてを単一のWorkflowやPipelineにまとめることなく、コード変更の範囲に応じてCIプロセスの関連部分をまとめて実行できます。各ビルドは独立して実行され、それぞれ個別の結果を返します。
トリガーの詳細な構文と正確なトリガー条件については、ビルドトリガーのYAML構文を参照してください。
コードイベントClick to copy link
ビルドをトリガーするには、次の3種類のコードイベントを使用できます。
-
コードプッシュ: トリガー条件に一致するコミットでコードをプッシュするたびに、自動的にビルドがトリガーされます。たとえば、プロジェクトのリポジトリの指定されたブランチへのコミットがビルドをトリガーします。
-
Pull request: プルリクエストがトリガー条件に一致するたびに、自動的にビルドがトリガーされます。たとえば、任意のプルリクエストがビルドをトリガーするソースブランチや宛先ブランチを指定できます。
最初のPRイベントプルリクエストは、最初のイベント時に一度だけビルドをトリガーします。ほとんどの場合、その最初のイベントはプルリクエストの作成です。たとえば、PRをドラフトPRに変換しても、別のビルドがトリガーされることはありません。プルリクエストの更新に対してビルドをトリガーするには、新しいコミット用にコードプッシュトリガーを設定してください。
-
Tag: プッシュしたタグがトリガー条件に一致するたびに、自動的にビルドがトリガーされます。たとえば、
vで始まるタグをプッシュすると、ビルドがトリガーされます。
条件Click to copy link
トリガー条件は、コードイベントに対するフィルターです。すべてのプルリクエストでビルドをトリガーする代わりに、特定のブランチを対象とするプルリクエストに対してトリガーを設定できます。
Gitプロバイダーによってサポートされる条件は異なります。詳細な一覧については、サポートされているトリガー条件を参照してください。
トリガー条件は、1つのトリガー内で組み合わせることができます。たとえば、PRが特定のブランチを対象とし、かつ特定のラベルを含む場合にのみビルド をトリガーするプルリクエストトリガーを設定できます。
トリガーの優先度Click to copy link
トリガーには優先度を設定できます。これにより、特定のトリガーによってトリガーされたビルドの優先度が決まります。優先度が高いほど、ビルドはbuild queueの上位に配置されます。
優先度は、Workflow Editor、またはプロジェクトのconfiguration YAMLファイルのいずれかで設定できます。優先度は常に-100から100までの整数で、数値が大きいほど優先度が高くなります。デフォルトの優先度は0です。Build priorityは、一部のプランでのみ利用できます。
build priorityの詳細、および優先度の種類間の優先順位については、Build priorityをご覧ください。
トリガー変数Click to copy link
自動的にトリガーされたビルド中は、ビルドトリガーに関連する多くのEnvironment Variablesを使用できます。これらの変数は、ビルドトリガーやプルリクエストの属性について詳細なコンテキストを提供します。トリガー変数は、次のような用途に使 用できます。
- コメント、ラベル、変更されたファイルなどのプルリクエストデータを使用して、複雑なワークフローや意思決定プロセスを自動化する。
- 誰がどのようにビルドをトリガーしたかを把握し、それを活用してワークフローのデバッグを改善する。
- 正確なビルド条件を実装して不要な実行を減らし、時間とリソースを節約する。
すべてのトリガー変数とその定義は、リファレンステーブル利用可能なenvironment variablesで確認できます。
トリガー変数は、要件を満たしている場合にのみ使用できます。たとえば、BITRISE_GIT_PULL_REQUEST_COMMENT変数は、ビルドがPRコメントによってトリガーされた場合、つまりビルドトリガーにpr_comment条件がある場合にのみ使用できます。正確な条件については、利用可能なenvironment variablesをご覧ください。
トリガー変数のユースケースClick to copy link
以下は、トリガー変数のユースケースの例です。これらはあくまで提案であり、変数を試しながら自分のニーズに最適なものを見つけることができます。
PRコメントへの返信BITRISE_GIT_PULL_REQUEST_COMMENT_ID: プルリクエストのコメントIDを使用して、プルリクエストの元のコメントに直接ステータス更新を投稿します。これには、成功、失敗、ログ、その他の関連情報などの詳細を含めることができます。
条件付きテスト実行BITRISE_GIT_CHANGED_FILES: コードベースの変更された部分を特定し、その変更に基づいて特定のテストスイートをトリガーします。たとえば、UIの変更に対してはフロントエンドテストを、APIの変更に対してはバックエンドテストを実行します。
コミットメッセージやラベルに基づいて異なる環境にデプロイするBITRISE_GIT_COMMIT_MESSAGESとBITRISE_GIT_PULL_REQUEST_LABELSを使用して、デプロイ環境を決定します。たとえば、コミットメッセージに「[staging]」が含まれている場合や、「ready-for-staging」ラベルが付いている場合は、コードをステージング環境にデプロイします。
マージキューのサポートClick to copy link
GitHubのマージキューを使用すると、複数のプルリクエスト(PR)をブランチに自動的にマージできます。ブランチフィルターとしてgh-readonly-queue/*を設定したトリガーを構成することで、各PRの変更をBitriseビルドで検証できます。このプレフィックスの詳細については、GitHubドキュメントをご覧ください。
マージキューは、キュー用にトリガーされたビルドがPRビルドと同じステータ ス名を報告する場合にのみ正しく機能します。
たとえば、以下の設定では、マージキューからマージされたすべてのブランチが、ci-pipeline Pipelineでビルドをトリガーします。
pipelines:
ci-pipeline:
triggers:
push:
- branch: "gh-readonly-queue/*"
status_report_name: ci/bitrise/<project_slug>/pr
GitHubのスタックされたプルリクエストClick to copy link
GitHubスタックは、大きな変更を一連の小さく順序付けられたプルリクエストに分割します。スタック内の各プルリクエストは、その下にあるプルリクエストのブランチを対象とし、スタック全体は1つのベースブランチに統合されます。
たとえば、3つのプルリクエストからなるスタックは、次のようになります。
feature/part-1はmainを対象とします。feature/part-2はfeature/part-1を対象とします。feature/part-3はfeature/part-2を対象とします。
3つのプルリクエストはすべて、最終的にmainに統合されます。
- トリガーは、プルリクエストが直接対象とするブランチではなく、スタックのベースブランチ(上記の例では
main)に対してターゲットブランチ条件を照合します。プルリクエストトリガーには、feature/part-1やfeature/part-2ではなくtarget_branch: mainを設定してください。 $BITRISEIO_GIT_BRANCH_DESTには、スタック内のすべてのプルリクエストについて、スタックのベースブランチ(main)が格納されます。