ビルドトリガーの設定

既存のトリガー設定

このページでは、WorkflowまたはPipeline内で定義される、ターゲットベースのビルドトリガーについて説明します。より詳細で柔軟なビルドトリガーシステムを利用できるため、すべての新規ユーザーにこの方法をお勧めします。

既存の設定では、レガシーなプロジェクトベースのトリガーを使用している場合があります。詳細については、レガシーなプロジェクトベースのトリガーをご覧ください。

ビルドトリガーの作成

ビルドトリガーは、WorkflowまたはPipeline内で直接作成します。このようなトリガーを使用すると、1つのコードイベントで複数のWorkflowsまたはPipelinesをトリガーできます。トリガーはUI、または設定YAMLファイルで作成できます。

トリガーを作成するには、次の手順に従います。

Workflow Editor

1. Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。

2. メインページの Workflows ボタンをクリックします。

3. Select a Workflow。

4. WorkflowのページでTriggersタブを選択します。

   

5. trigger typeを選択し、Add triggerボタンをクリックします。

6. ダイアログでトリガーを設定します。

   トリガー条件の値を定義する際に正規表現を使用するには、正規表現パターンボタンをクリックして有効にします。

   

7. 完了したら、Add triggerをクリックします。

Configuration YAML

1. 設定YAMLファイルを開きます。

2. Workflowを見つけます。

3. Workflow内にtriggersプロパティを追加します。

   my-workflow:
     triggers:

4. トリガーを作成します。各トリガータイプの正確な構文については、YAMLのビルドトリガー構文をご覧ください。

   たとえば、次のトリガーはmy-workflowという名前のWorkflowでビルドを開始します。

   my-workflow:
     triggers:
       push:
       - commit_message: your_message

   パターンマッチングには2つのプロパティを使用できます。

   • patternを使用すると、シンプルなワイルドカードマッチングを利用できます。
   • regexを使用すると、正規表現による複雑なパターンマッチングを利用できます。

   my_awesome_workflow
     triggers:
       push:
         - branch: main
         - commit_message:
             pattern: "hello"
             last_commit: true
       pull_request:
         - source_branch: "*"

5. 設定を保存します。

Triggersページでターゲットベースのトリガーを新規追加する

Triggersページを離れることなく、新しいターゲットベースのトリガーをすばやく追加できます。たとえば、アクティブなトリガーを確認した後、コンテキストを切り替えずにすぐ別のトリガーを追加でき、設定作業を効率化できます。

1. プロジェクトのTriggersページに移動します。

2. まだトリガーがない場合、Triggersページの中央に新しいAdd Triggerボタンが表示されます。Add triggerをクリックし、ダイアログに入力します。

   

3. すでにターゲットベースのトリガーがある場合、add triggerボタンはトリガーの上、右上に表示されます。add triggerをクリックし、ダイアログに入力します。

   

ここでトリガーを追加すると特定のワークフローが作成され、そのワークフローのTriggersタブがWorkflowsページに表示されるため、簡単に管理できます。

トリガーの無効化

任意のビルドトリガーを一時的に無効にできます。無効化されたトリガーはビルドをトリガーしませんが、設定情報はすべて保持されます。無効化したトリガーはいつでも再度有効にできます。

ビルドトリガーを無効にするには、次の手順に従います。

Workflow Editor

1. BitriseでWorkflow Editorを開きます。

2. Select a WorkflowまたはPipeline。

3. WorkflowページでTriggersタブを選択します。

   

4. 必要なトリガーを見つけ、その名前の横にあるオプションメニュー(⋮)をクリックします。

   

5. トリガーを無効化を選択します。

Configuration YAML

1. 設定YAMLファイルを開きます。

2. WorkflowまたはPipelineとそのtriggersプロパティを見つけます。

3. 無効にしたいトリガーにenabled: falseを追加します。

   triggers:
     push:
     - branch: main
       enabled: false

最新のGitコミットに対するトリガーの作成

デフォルトでは、コードプッシュトリガーでCommit messageまたはFile change条件を使用する場合、Bitriseは1回のコードプッシュに含まれるすべてのコミットメッセージとすべての変更ファイルを評価します。

ただし、プッシュ内の最新のコミットのみを評価するようにトリガーを設定することもできます。プッシュに複数のコミットが含まれる場合、評価されるのは最新の1件のみです。

Workflow Editor

1. 新しいプッシュトリガーの作成を参照してください。

2. Commit messageまたはFile change条件のいずれかを選択します。

   

3. 条件の下でLast commit onlyを有効にします。

Configuration YAML

1. 設定YAMLファイルを開き、Workflowに移動します。

2. 新しいプッシュトリガーを追加します。この例ではcommit_message条件を使用しています。

   my-workflow:
     triggers:
       push:
       - commit_message: your_message

3. last_commitプロパティを追加し、trueに設定します。

   my-workflow:
     triggers:
       push:
       - commit_message: your_message
         last_commit: true

ドラフトPRからのビルドトリガー実行

GitHubとGitLabには、ドラフトプルリクエスト(GitLabの場合はマージリクエスト)という機能があります。プルリクエスト(PR)を作成する際、レビュー可能な状態のプルリクエストとして作成するか、ドラフトプルリクエストとして作成するかを選択できます。ドラフトプルリクエストはマージできず、コードオーナーに自動的にレビューが依頼されることもありません。

Gitプロバイダーの制限事項

この機能はGitHubおよびGitLabのリポジトリでのみサポートされています。

デフォルトでは、ドラフトPRを開くとビルドがトリガーされます。この動作はいつでも無効にできます。

ドラフトPRを開いた際にビルドがトリガーされた場合、それをレビュー用に提出しても(つまり「正式な」PRに変換しても)、再度トリガーされることはありません。ドラフトPRのトリガー設定によって、どのコードイベントでビルドがトリガーされるかを確認できます。ドラフトPRのビルドトリガーの動作。

それぞれのトリガーには個別のトグルがあり、特定のトリガーはドラフトPRからビルドを開始し、他のトリガーは開始しないようにアプリを設定できます。

ドラフトPRからのビルドの無効化

ビルドがドラフトPRによってトリガーされた場合のStepsのスキップ

このガイドでは、ドラフトPRからのビルドトリガーを完全に無効にする方法を説明します。ただし、ドラフトプルリクエストによってトリガーされたビルド内で特定のStepsをスキップすることも可能です。その場合は、run_if条件とGITHUB_PR_IS_DRAFT環境変数を使用するだけです。詳細については、Stepの条件付き有効化・無効化をご覧ください。

Workflow Editor

1. Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。

2. メインページの Workflows ボタンをクリックします。

3. Workflowを開き、Triggersタブを選択します。

   Pipelineがある場合、この設定は設定YAMLファイルでのみ無効にできます。

4. 必要なトリガーを見つけ、その名前の横にあるオプションメニュー(⋮)をクリックします。

5. メニューからEdit triggerを選択します。

   

6. Include draft pull requestsオプションのチェックを外し、Apply changesをクリックします。

Configuration YAML

1. 設定YAMLファイルを開きます。

2. 変更したいすべてのWorkflowsまたはPipelines内のtriggers要素を見つけます。

3. 必要なトリガーエントリにdraft_enabled: falseを追加します。

   triggers:
         pull_request:
         - target_branch: "develop"
           draft_enabled: false
         - target_branch: "main"
           draft_enabled: false
         - comment: 'run Bitrise'

   これにより、developブランチとmainブランチに対する非ドラフトのPR、または任意のPRにrun Bitriseがコメントされた場合にワークフローが開始されます。

ドラフトPRのビルドトリガーの動作

この表は、ドラフトPRのトリガー設定に応じて、ドラフトPRに関する特定のアクションが実行されたときにビルドがトリガーされるかどうかを示しています。たとえば、ドラフトPRをPRに変換する場合、ドラフトPRトリガーが有効になっているとビルドはトリガーされませんが、無効になっているとトリガーされます。

アクション	ドラフトPRトリガーが有効な場合	ドラフトPRトリガーが無効な場合
ドラフトPRを開く
ドラフトPRにコミットをプッシュする
ドラフトPRをPRに変換する
PRをドラフトPRに変換する

サポートされているトリガー条件

すべてのトリガー条件がすべてのGitプロバイダーで利用できるわけではありません。詳細については、プッシュトリガーとプルリクエストトリガーの両方の表を確認してください。

プッシュトリガー条件

Gitプロバイダー	ブランチ	コミットメッセージ	変更されたファイル
GitHub(クラウドおよびセルフホスト)
GitLab(クラウドおよびセルフホスト)
Bitbucket(クラウドおよびセルフホスト)
Assembla
Deveo (Perforce)
Gogs
Azure DevOps

プルリクエストトリガー条件

Gitプロバイダー	Source branch	ターゲットブランチ	ラベル	コメント	コミットメッセージ	変更されたファイル
GitHub(クラウドおよびセルフホスト)
GitLab(クラウドおよびセルフホスト)
Bitbucket(クラウドおよびセルフホスト)			N/A
Assembla			N/A
Deveo (Perforce)
Gogs
Azure DevOps

Assembla、Deveo、Gogsではプルリクエストトリガーが利用不可

Assembla、Deveo(Perforce)、Gogsはプッシュベースのトリガーのみをサポートしています。これらのプロバイダーではプルリクエストトリガーは利用できません。

GitHubのスタックされたプルリクエスト

GitHubスタック内のプルリクエストの場合、Bitriseはターゲットブランチ条件を、プルリクエストが直接ターゲットとするブランチではなく、スタックのベースブランチと照合します。

feature/part-2がfeature/part-1をターゲットとし、スタック全体がmainにマージされるスタックを例に考えます。target_branch: main条件はスタック内のすべてのプルリクエストに一致します。feature/part-1に設定された条件はいずれにも一致しません。