ビルドを自動的にトリガーする

概要

トリガーイベントとワークフローを指定することにより、Bitriseで自動ビルドトリガーを構成できます。コードプッシュ、プルリクエスト、またはGitタグからビルドをトリガーできます。

ビルドをトリガーするコードイベントと実行する宛先ワークフローを指定することにより、Bitrise で自動ビルドトリガーを設定できます。同じアプリに対して複数のトリガーを定義できます。

デフォルトでは、1 つのトリガーでトリガーできるワークフローは 1 つだけです。 1 つのトリガーから複数のワークフローをトリガーする必要がある場合は、いくつかの方法があります。

パイプラインの使用: パイプラインでは、ワークフローが各ステージで並行して実行され、パイプライントリガーによってパイプラインの最初のステージが開始されます。続きを読む：パイプライントリガーの構成。
ワークフローをつなぐだから彼らはお互いを追いかけます。
使用 Bitrise Start Build そしてその Bitriseビルドを待つ 手順。

トリガーには次の3つのタイプがあります。

コードプッシュ: 条件に一致するコミットを使用してコードをプッシュするたびに、ビルドが自動的にトリガーされます。たとえば、アプリのリポジトリの指定されたブランチへのコミットによってビルドがトリガーされます。
プルリクエスト: プルリクエストが条件に一致するたびに、ビルドを自動的にトリガーします。たとえば、プルリクエストによってビルドがトリガーされるソースブランチや宛先ブランチを指定できます。
Git タグ: 特定のタグが付いたコミットがビルドをトリガーするたびに、ビルドを自動的にトリガーします。

トリガー条件

各トリガータイプには、複数の異なるトリガー条件を設定できます。使用可能なトリガー条件は、各トリガータイプの作成手順にリストされ、説明されています。

すべてのトリガー条件がすべてのGitプロバイダーでサポートされているわけではありません。詳細なリストについては、サポートされているトリガー条件。

トリガーは、トリガーワークフローエディタのセクションまたは直接編集することもできます bitrise.yml アプリの設定を行います。

また、同じブランチ（たとえば、main）で同じコードイベント（たとえば、コードプッシュ）に対して2つの異なるトリガーを設定することはできません。ワークフローエディタでは、保存しようとしても構成を保存できません。

コードプッシュトリガー

コードプッシュトリガーは、アプリのリポジトリ内のコードが変更されるたびにビルドを開始します。

コードプッシュトリガーには、次の 3 つの条件タイプがあります。

プッシュブランチ: アプリのリポジトリの指定されたブランチでのコミットのみが新しいビルドをトリガーします。
コミットメッセージ: 指定されたコミットメッセージのみが新しいビルドをトリガーします。たとえば、次のコミットメッセージがあるとします。 hotfix critical: Resolved security vulnerability in user authenticationワイルドカードパターンを使うこともできます。 hotfix.*または次のような正規表現パターン hotfix\s*(critical|high):.* このようなコミットメッセージのビルドをトリガーします。
ファイルが変更された: 特定のファイルが変更された場合のみビルドが実行されます。これはモノレポの設定、つまり単一のリポジトリに複数の異なるプロジェクトのコードが含まれている場合に特に便利です。たとえば、次のような正規表現パターンは ios/.*\.swift$ モノレポ内でiOSディレクトリ内のSwiftファイルのみが変更された場合にのみビルドをトリガーできます。同様に、次のような単純なワイルドカードパターンも使用できます。 ios/app.js or ios/components/MyView.swift または ios/layouts/main_screen.xml 関連するディレクトリ内の特定のファイルをターゲットにしてビルドをトリガーできます。

これらの条件は組み合わせることもできます。例えば、特定のファイルが変更されたときにビルドを開始するトリガーを設定できます。主要アプリのリポジトリのブランチ。トリガーごとに少なくとも 1 つの条件を構成する必要があります。複数の条件を設定する場合、ビルドをトリガーするにはすべての条件が満たされている必要があります。

トリガー構成では正規表現を使用できます。正規表現を使用して、ブランチ、コミットメッセージ、またはファイル名を一致させることができます。最初の一致によってビルドがトリガーされ、後続の一致は無視されます。

コードプッシュのトリガーを作成する

ワークフローエディター

ビットライズ

リポジトリへのOAuth接続を使用する場合は、 Bitriseウェブフックリポジトリに登録されます。GitHub App 統合を使用する場合、Webhook は必要ありません。
でアプリを開きますビットライズ。
クリックワークフローメインページのボタン。
左側で、トリガー。
上のトリガーページで、押すタブ。
クリックプッシュトリガーを追加。
の中にプッシュトリガーを追加ダイアログで、1 つ以上のトリガー条件を設定します。
- ブランチをプッシュ: 指定されたブランチへのコミットによりビルドがトリガーされます。
- コミットメッセージ: 指定されたコミットメッセージを含むコミットによりビルドがトリガーされます。
- ファイルの変更: 指定されたファイルに変更を加えるとビルドがトリガーされます。
複数の条件を設定する場合、ビルドを開始するにはすべての条件を満たす必要があります。

どの条件タイプにも正規表現を使用できます。
クリック次それが終わったら。
条件が満たされたときにBitriseが実行するワークフローまたはパイプラインを選択します。完了したら、トリガーを追加。

YAML でのトリガー

YAML形式でビルドトリガーを定義する方法の詳細については、以下を参照してください。構成YAMLでのビルドトリガー。

リポジトリへのOAuth接続を使用する場合は、 Bitriseウェブフックリポジトリに登録されます。GitHub App 統合を使用する場合、Webhook は必要ありません。
開く bitrise.yml ファイル。
下 trigger_map、タイプを次のように定義して新しいトリガーを追加します。 push トリガー条件を設定します。
```
trigger_map:
- type: push
  commit_message: your_message
```
この例では、 commit_message トリガー条件として利用可能な条件は：
- push_branch: 指定されたブランチへのコミットによりビルドがトリガーされます。
- commit_message: 指定されたコミットメッセージを含むコミットによりビルドがトリガーされます。
- changed_files: 指定されたファイルに変更を加えるとビルドがトリガーされます。
どちらにも正規表現を使うことができます。 regex: トリガー条件に追加します。例:
```
commit_message: 
  regex: ".*"
```
トリガーするワークフローまたはパイプラインを追加します。
```
trigger_map:
- type: push
  commit_message: your_message
  workflow: primary
```

これで完了です。今後、アプリのリポジトリの選択したブランチにコードがプッシュされると、Bitrise は選択したワークフローまたはパイプラインを使用してビルドをトリガーします。

プルリクエストトリガー

プルリクエストトリガーは、アプリのリポジトリでプルリクエストが開かれるたびにビルドを開始します。

プルリクエストトリガーには、次の 3 つの条件タイプがあります。

ソースブランチ: プルリクエストの変更が含まれるブランチの名前。
ターゲットブランチ: プルリクエストをマージするブランチの名前。
プルリクエストコメント: プルリクエストに送信された指定されたコメント。
プルリクエストラベル: 特定のラベルが適用されたプルリクエストのみがビルドをトリガーします。たとえば、build-test などのラベルを追加して、特定の PR のビルドを手動でトリガーします。
Pull request commit messages.

BitriseはPRのすべてのコミットメッセージをチェックします

プルリクエストトリガーはプルリクエストのすべてのコミットをチェックすることに注意してください。コミットメッセージが条件に一致すると、Bitrise はビルドをトリガーします。

この動作が目的に合わない場合は、コードプッシュトリガーその代わり。
Pull request file changes.

これらの条件は組み合わせることができます。たとえば、特定のラベルが付いた特定のソースブランチからプルリクエストが開かれたときにビルドを開始するトリガーを設定できます。トリガーごとに少なくとも 1 つの条件を構成する必要があります。複数の条件を設定する場合、ビルドをトリガーするには、すべての条件が満たされている必要があります。

トリガー構成では正規表現を使用できます。正規表現を使用してブランチまたは PR ラベルを一致させることができます。最初の一致によってビルドがトリガーされ、それ以降の潜在的な一致は無視されます。

プルリクエストによってトリガーされたビルドは、手動の承認の対象となる場合があります。プルリクエストビルドの承認。

デフォルトでは、ドラフトプルリクエストもビルドをトリガーします。これはいつでも無効にできます。ドラフト PR からのビルドのトリガー。

プルリクエストのトリガーを作成する

ワークフローエディター

ビットライズ

必ず Bitriseウェブフックリポジトリに登録されました。
でアプリを開きますビットライズ。
クリックワークフローメインページのボタン。
左側で、トリガー。
上のトリガーページで、プルリクエストタブ。
クリックプルリクエストトリガーを追加する。
の中にプルリクエストトリガーを追加するダイアログで、ビルドをトリガーする 1 つ以上のトリガー条件を設定します。
- ソースブランチ: プルリクエストが開かれたブランチ。
- 対象ブランチ: プルリクエストがマージされるブランチ。
- PRラベル: PR に適用されるラベル。
- PRコメント: プルリクエストに送信された指定されたコメント。プルリクエスト内のいずれかのコミットメッセージが条件に一致する場合、Bitrise はビルドをトリガーすることに注意してください。
- コミットメッセージ: プルリクエストのコミットメッセージの 1 つ。
- ファイルの変更: プルリクエスト内の指定されたファイルへの変更。
プルリクエストトリガーの制限

使用するにはPRコメントトリガー、許可プルリクエストコメント Git プロバイダーで webhook ペイロードとして渡されます。2 つのイベントを有効にします。コメントを作成しました、コメントを更新しました。

複数の条件を設定する場合、ビルドを開始するにはすべての条件を満たす必要があります。

どの条件タイプにも正規表現を使用できます。
クリック次それが終わったら。
条件が満たされたときにBitriseが実行するワークフローまたはパイプラインを選択します。完了したら、トリガーを追加。

YAML でのトリガー

YAML形式でビルドトリガーを定義する方法の詳細については、以下を参照してください。構成YAMLでのビルドトリガー。

必ず Bitriseウェブフックリポジトリに登録されました。
開く bitrise.yml ファイル。
下 trigger_map、タイプを次のように定義して新しいトリガーを追加します。 pull-request トリガー条件を設定します。
```
trigger_map:
- type: pull-request
  pull_request_target_branch:
    regex: ".*"
```
この例では、 pull_request_target_branch 正規表現を使用したトリガー条件として。利用可能な条件それぞれに正規表現を使用できます。
- pull_request_source_branch: 指定されたブランチから開かれたプルリクエストによってビルドがトリガーされます。
- pull_request_target_branch: 指定されたブランチにマージされるプルリクエストによってビルドがトリガーされます。
- pull_request_label: 指定されたラベルを持つプルリクエストはビルドをトリガーします。
どちらにも正規表現を使うことができます。 regex: トリガー条件に。

トリガーするワークフローまたはパイプラインを追加します。

trigger_map:
- type: pull-request
  pull_request_target_branch:
    regex: ".*"
  workflow: primary

そして、あなたは完了です！今後、リポジトリでプルリクエストが開かれると、Bitriseは選択されたワークフローでビルドをトリガーします。

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

GitHub では、と呼ばれる機能を提供しています。プルリクエストのドラフト: プルリクエスト (PR) を作成するときに、レビューの準備ができているプルリクエストを作成するか、ドラフトプルリクエストを作成するかを選択できます。ドラフトプルリクエストはマージできず、コード所有者はドラフトプルリクエストをレビューするように自動的に要求されません。

Git プロバイダーの制限

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

ドラフト PR は、他の PR と同様に Bitrise でビルドをトリガーできます。ただし、ドラフト PR が完全なビルドをトリガーして実行しないようにすることもできます。ビルドまたはビルド内の特定のステップをスキップするには、 GITHUB_PR_IS_DRAFT 環境変数。

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

ドラフト PR からのビルドを無効にする

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

ドラフトプルリクエストによってトリガーされるビルドの特定のステップをスキップすることもできます。使用する必要があるのは、 run_if 状態: 詳細については、を参照してください。ステップを条件付きで有効または無効にする。

ワークフローエディター

ビットライズ

でアプリを開きますビットライズ。
クリックワークフローメインページのボタン。
左側で、トリガー。
必要なトリガーを見つけて、ドラフトプルリクエストが有効スイッチ。

開く bitrise.yml ファイル。
の中に trigger_map プロパティでトリガーを見つけます。 type: pull_request 分野。

追加 draft_pull_request_enabled: false それに。

trigger_map:
- type: pull-request
  pull_request_target_branch: main
  workflow: primary
  draft_pull_request_enabled: false

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

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

表1 トリガー動作

アクション	ドラフトPRトリガーが有効になっています	ドラフトPRトリガーは無効です
ドラフトPRを開く
ドラフトPRにコミットをプッシュする
ドラフトPRをPRに変換する
PR をドラフト PR に変換する

Git タグトリガー

Gitタグトリガーは、指定されたタグを持つコミットが行われるたびにビルドを開始します。 Gitタグアプリのリポジトリにプッシュされます。

タグトリガーの場合、可能な条件はタグ自体のみです。トリガーを設定するときは、完全なタグまたは正規表現パターンのいずれかを設定する必要があります。

Git タグトリガーの作成

GitLabなどの特定のプロバイダーでは、Webhookのセットアップでタグプッシュイベントを特別に有効にする必要があることに注意してください。

ワークフローエディター

ビットライズ

必ず Bitriseウェブフックリポジトリに登録されました。
Git プロバイダーで必要な場合は、Webhook 構成でタグプッシュイベントが有効になっていることを確認してください。

たとえば、GitLab ではこれが必要です。
でアプリを開きますビットライズ。
クリックワークフローメインページのボタン。
左側で、トリガー。
上のトリガーページで、鬼ごっこタブ。
クリックタグトリガーを追加。
の中にタグトリガーを追加ダイアログでタグを追加鬼ごっこ分野。

完全なタグの代わりに正規表現を使用できます。
クリック次それが終わったら。
条件が満たされたときにBitriseが実行するワークフローまたはパイプラインを選択します。完了したら、トリガーを追加。

YAML でのトリガー

ビルドトリガーをYAML形式で定義する方法の詳細については、以下を参照してください。構成YAMLでのビルドトリガー。

必ず Bitriseウェブフックリポジトリに登録されました。
開く bitrise.yml ファイル。
下 trigger_map、タイプを次のように定義して新しいトリガーを追加します。 tag-push そして、 tag トリガー条件:
```
trigger_map:
- type: tag-push
  tag: '*'
```
この例では、タグのプッシュ時にビルドをトリガーするワイルドカードを使用します。
トリガーするワークフローまたはパイプラインを追加します。
```
trigger_map:
- type: tag-push
  tag: '*'
  workflow: primary
```

トリガーの無効化

ビルドトリガーを一時的に非アクティブ化できます。非アクティブ化されたトリガーはビルドをトリガーしませんが、すべての構成情報を保持します。将来トリガーが再び必要になった場合、トリガーを再作成する必要はありません。1 回のクリックで再度アクティブ化できます。

ビルドトリガーを非アクティブ化するには:

ワークフローエディター

ビットライズ

Bitrise でワークフローエディターを開きます。
左側で、トリガー。
非アクティブ化するトリガーに応じて、適切なタブを選択します。
トリガーを設定する非活性。

開く bitrise.yml ファイル。
を見つける trigger_map プロパティと無効にするトリガー。

追加 enabled: false それに。

trigger_map:
- type: push
  push_branch: main
  workflow: primary
  enabled: false

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

すべてのトリガー条件がすべての Git プロバイダーで利用できるわけではありません。原則として、すべてのトリガー条件は、最もよく使用される 3 つの Git プロバイダー (GitHub、GitLab、Bitbucket) のクラウドサービスで利用できます。その他のプロバイダーまたは自己ホスト型 Git リポジトリについては、プッシュトリガーとプルリクエストトリガーの両方の詳細な表を確認してください。

表1 コードプッシュトリガーでサポートされているトリガー条件

Git プロバイダー	支店	コミットメッセージ	ファイルが変更されました
GitHub (クラウド)
GitHub (セルフホスト)
GitLab (クラウド)
GitLab (セルフホスト)
Bitbucket (クラウド)
BitBucket Server (セルフホスト)
アセンブラ
デベオ（Perforce）
ゴグス
VS チームサービス

表2 プルリクエストトリガーでサポートされているトリガー条件

Git プロバイダー	ソースブランチ	対象ブランチ	ラベル	コメント	コミットメッセージ	変更されたファイル
GitHub (クラウド)
GitHub (セルフホスト)
GitLab (クラウド)
GitLab (セルフホスト)
Bitbucket (クラウド)			該当なし
BitBucket Server (セルフホスト)			該当なし
アセンブラ			該当なし
デベオ（Perforce）
ゴグス
VS チームサービス

このセクションの内容:

参照:

ビルドを自動的にトリガーする

トリガー条件

コードプッシュトリガー

コードプッシュのトリガーを作成する

YAML でのトリガー

プルリクエストトリガー

BitriseはPRのすべてのコミットメッセージをチェックします

プルリクエストのトリガーを作成する

プルリクエストトリガーの制限

YAML でのトリガー

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

Git プロバイダーの制限

ドラフト PR からのビルドを無効にする

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

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

Git タグ トリガー

Git タグトリガーの作成

YAML でのトリガー

トリガーの無効化

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

検索結果

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

Git タグトリガー