Skip to main content

従来のプロジェクトベースのトリガー

概要

レガシーまたはプロジェクトベースのトリガーは、プロジェクト レベル、つまり構成 YAML ファイルの最上位レベルで定義されます。トリガーは、特定のコード イベントが発生したときに実行するワークフローまたはパイプラインを定義します。1 つのコード イベントは、1 つのビルドのみをトリガーできます。

レガシートリガー

このページでは、プロジェクト レベルで定義されるレガシー トリガーについて説明します。新規ユーザーには、ワークフローとパイプラインのレベルで定義されるターゲットベースのビルド トリガーを使用することを強くお勧めします。これにより、トリガーをより柔軟に設計できます。 ビルドトリガー。

レガシーまたはプロジェクトベースのトリガーは、プロジェクト レベル、つまり構成 YAML ファイルの最上位レベルで定義されます。トリガーは、特定のコード イベントが発生したときに実行するワークフローまたはパイプラインを定義します。1 つのコード イベントは、1 つのビルドのみをトリガーできます。

プロジェクトベースのトリガーの作成

概要

プロジェクトベースのトリガーは、プロジェクト レベル、つまり構成 YAML ファイルの最上位レベルで定義されます。トリガーは、特定のコード イベントが発生したときにどのワークフローまたはパイプラインを実行するかを定義します。1 つのコード イベントは 1 つのビルドのみをトリガーできます。

プロジェクトベースのトリガーはプロジェクト レベル、つまり構成 YAML ファイルの最上位レベルで定義されます。トリガーは、特定のコード イベントが発生したときに実行するワークフローまたはパイプラインを定義します。1 つのコード イベントは 1 つのビルドのみをトリガーできます。

ワークフローエディター

構成YAML

  1. でアプリを開きます ビットライズ。

  2. クリック ワークフロー メインページのボタン。

    opening-workflow-editor.png

  3. ワークフローを選択します。

    push-trigger.png

  4. トリガータイプを選択し、 トリガーを追加 ボタン。

    たとえば、プル リクエスト イベントのトリガーを設定する場合は、[プル リクエスト] タブを選択します。

  5. クリック トリガーを追加 ボタン。

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

    複数の条件を設定する場合、ビルドを開始するにはすべての条件が満たされている必要があります。どの条件タイプにも正規表現を使用できます。

    サポートされているトリガー条件の完全なリストは、次の場所にあります。 サポートされているトリガー条件

  7. 完了したらクリック トリガーを追加。

  1. 構成 YAML ファイルを開きます。

  2. ワークフローで、 trigger_map プロパティを作成し、その下にトリガーを設定します。必要なもの:

    • あ type コード イベントのタイプを定義するプロパティ。

    • トリガー条件。例えば、 commit_message。

    • トリガーするワークフローまたはパイプライン。

    trigger_map:
- type: push
  commit_message: your_message
  workflow: my-workflow

    さまざまなトリガー タイプの正確な構文については、以下を参照してください。 ビルドトリガーの YAML 構文。

  3. 設定を保存します。

プロジェクトベースのトリガーを無効にする

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

ワークフローエディター

ビットライズ

  1. Bitrise でワークフロー エディターを開きます。

  2. 左側で、 トリガー。

  3. 非アクティブ化するトリガーに応じて、適切なタブを選択します。

    two-pr-triggers.png

  4. トリガーを設定する 非活性。

  1. 開く bitrise.yml ファイル。

  2. を見つける trigger_map プロパティと無効にするトリガー。

  3. 追加 enabled: false それに。

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

プロジェクトベースのトリガー構文

トリガーには主に 3 つの要素があります。

  • トリガーのタイプ: push、 pull_request、 または tag。

  • トリガー条件。たとえば、プル リクエストのソース ブランチなど。

  • トリガーされるワークフローまたはパイプライン。

1つのトリガーは1つのビルドを意味します。1つのトリガーは1つのワークフローまたはパイプラインのみをトリガーできます。 ワークフローを連結する 単一のトリガーから複数のワークフローを連続して実行します。

以下は、ビルドをトリガーする単一のトリガーです。 primary 任意のブランチからプル リクエストが開かれたときのワークフロー。

trigger_map:
- pull_request_source_branch: "*"  
  type: pull_request  
  workflow: primary

トリガーの順序

トリガーの順序は重要です。条件が一致する最初のトリガーがビルドをトリガーします。たとえば、コード プッシュ トリガーが 2 つあるとします。

trigger_map:
- type: push
  push_branch: main
  workflow: primary
- type: push
  commit_message: deploy
  workflow: deploy

最初のトリガーは primary コードがプッシュされた場合のワークフロー main アプリのリポジトリのブランチ。

2番目のトリガーは deploy コミットメッセージ付きのコミットの場合のワークフロー deploy リポジトリの任意のブランチにプッシュされます。

コミットがプッシュされると何が起こるか main コミットメッセージ付きのブランチ deploy? コミットは最初のトリガーのすべての条件に一致するので、 primary ワークフローがトリガーされます。このシナリオでは、 deploy コミットがそのトリガーのすべての条件に一致しているにもかかわらず、ワークフローはトリガーされません。

複数のトリガー条件

1 つの項目に複数のトリガー条件を定義した場合、ビルドをトリガーするにはすべての条件が一致する必要があります。例:

trigger_map:
- pull_request_target_branch: "main"
  pull_request_source_branch: "develop"
  type: pull_request
  workflow: primary

これにより、 primary プルリクエストのソースブランチが develop かつ、ターゲットブランチは main。

プロジェクトベースのトリガーコンポーネント

このページにリストされているコンポーネントは、従来のプロジェクトベースのトリガーに有効です。

表1 すべてのトリガータイプのコンポーネント

成分

説明

許容値

デフォルト値

type

プロジェクトベースのトリガーのタイプを定義します。特定のタイプのトリガーは、そのタイプに属するトリガー条件のみを受け入れます。

  • push

  • pull_request

  • tag

該当なし

enabled

トリガーが現在アクティブかどうかを定義するブール型プロパティ。

  • true

  • false

true

workflow または pipeline

トリガーされるワークフローまたはパイプライン。両方を設定することはできません。

ワークフローまたはパイプラインの正確な名前。

該当なし

表2 コードプッシュトリガーのコンポーネント

成分

説明

デフォルト値

push_branch

ビルドをトリガーするためにコードがプッシュされるリポジトリのブランチ。

*

commit_message

ビルドをトリガーするコミット メッセージ。

*

changed_files

変更によってビルドをトリガーするファイルまたはフォルダーへのパス。

*

表3 プルリクエストトリガーのコンポーネント

成分

説明

デフォルト値

pull_request_source_branch

プル リクエストが開かれるブランチ。

*

pull_request_target_branch

プルリクエストのマージ対象となるブランチ。

*

pull_request_label

プルリクエストのラベル。

*

draft_pull_request_enabled

ドラフト プル リクエストがビルドをトリガーするかどうかを定義するブール プロパティ。

true

pull_request_comment

プルリクエストに投稿されたコメント。

*

commit_message

プル リクエストへのプッシュ内の特定のコミット メッセージ。

*

changed_files

プル リクエストで変更される特定のファイル。

*

表4 タグトリガーのコンポーネント

成分

説明

デフォルト値

tag

タグの値。文字列値または regex 財産。

*

このセクションの内容:
プロジェクト