ビルドトリガー

概要

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

既存のトリガー構成

このページでは、ワークフローまたはパイプライン内で定義されるターゲットベースのビルドトリガーについて詳しく説明します。よりきめ細かく柔軟なビルドトリガーシステムを提供するため、すべての新規ユーザーにはこのアプローチをお勧めします。

既存の構成では、従来のプロジェクトベースのトリガーが使用される場合があります。詳細については、以下を参照してください。従来のプロジェクトベースのトリガー。

ビルドトリガーの作成

ビルドトリガーは、ワークフローまたはパイプラインで直接作成します。このようなトリガーを使用すると、単一のコードイベントで複数のワークフローまたはパイプラインをトリガーできます。トリガーは、UI または構成 YAML ファイルで作成できます。

トリガーを作成するには:

ワークフローエディター

構成YAML

でアプリを開きますビットライズ。
クリックワークフローメインページのボタン。
ワークフローを選択します。
選択してくださいトリガーワークフローのページのタブ。
トリガータイプを選択し、トリガーを追加ボタン。
ダイアログでトリガーを設定します。

トリガー条件の値を定義するときに正規表現を有効にするには、正規表現パターンボタンをクリックします。
完了したらクリックトリガーを追加。

構成 YAML ファイルを開きます。
ワークフローを見つけます。
ワークフローで、 triggers 財産。
```
my-workflow:
  triggers:
```
トリガーを作成します。さまざまなトリガータイプの正確な構文については、以下を参照してください。ビルドトリガーの YAML 構文。

たとえば、このトリガーはというワークフローでビルドを開始します my-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: "*"
```
設定を保存します。

Adding a new target-based trigger on the Triggers page

You can quickly add new target-based triggers without leaving the Triggers page. For example, after reviewing your active triggers, you can immediately add another one without switching context, speeding up your setup process.

Go to your project's Triggers page.
If you don't have triggers yet, you’ll see a new Add Trigger button in the middle on the Triggers page. Click Add trigger and fill out the dialog.
If you already have target-based triggers, the add trigger button is above the triggers in the top-right corner. Click add trigger and fill out the dialog.

Adding a trigger here creates a specific workflow, which then appears under that workflow’s Triggers tab on the Workflows page for easy management.

トリガーを無効にする

ビルドトリガーを一時的に無効にすることができます。無効にされたトリガーはビルドをトリガーしませんが、すべての構成情報は保持されます。無効にされたトリガーはいつでも再アクティブ化できます。

ビルドトリガーを無効にするには:

ワークフローエディター

構成YAML

Bitrise でワークフローエディターを開きます。
ワークフローまたはパイプラインを選択します。
ワークフローページで、トリガータブ。
必要なトリガーを見つけて、その名前の横にある縦の省略記号をクリックします。
選択トリガーを無効にする。

構成 YAML ファイルを開きます。
ワークフローまたはパイプラインとその triggers 財産。
追加 enabled: false 無効にするトリガーに追加します。
```
triggers:
  push:
  - branch: main
    enabled: false
```

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

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

Git プロバイダーの制限

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

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

ドラフトPRを開くとビルドがトリガーされる場合、レビュー用に送信する（つまり「完全な」PRに変換する）と、別のビルドはトリガーされません。ドラフトの PR トリガー設定に応じて、ビルドをトリガーする正確なコードイベントを確認できますドラフト PR のビルドトリガー動作.

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

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

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

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

ワークフローエディター

ビットライズ

でアプリを開きますビットライズ。
クリックワークフローメインページのボタン。
ワークフローを開いて、以下を選択します。トリガータブ。

パイプラインを使用している場合は、設定 YAML ファイルの設定のみを無効にできます。
必要なトリガーを見つけて、名前の横にある縦の省略記号をクリックします。
[選択] トリガーを編集メニューから。
チェックを外すドラフトプルリクエストを含めるオプションを押してクリック [変更を適用]。

設定 YAML ファイルを開きます。
見つけて triggers 変更したいすべてのワークフローまたはパイプラインの要素。
[追加] draft_enabled: false 必要なトリガーエントリへ。
```
triggers:
      pull_request:
      - target_branch: "develop"
        draft_enabled: false
      - target_branch: "main"
        draft_enabled: false
      - comment: 'run Bitrise'
```
これにより、開発ブランチとメインブランチに対して、またはいつでも、ドラフト以外の PR のワークフローが開始されます。 run Bitrise どの PR でもコメントされています。

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

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

表 46. トリガー動作

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

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

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

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

Git プロバイダー	支店	コミットメッセージ	ファイルが変更されました
GitHub (クラウドとセルフホスト)
GitLab (クラウドおよびセルフホスト)
Bitbucket (クラウドおよびセルフホスト)
アセンブラ
デベオ（Perforce）
ゴグス
Azure DevOps

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

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

このセクションの内容:

参照:

ビルドトリガー

既存のトリガー構成

ビルドトリガーの作成

Adding a new target-based trigger on the Triggers page

トリガーを無効にする

最新の Git コミットのトリガー

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

Git プロバイダーの制限

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

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

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

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

検索結果

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