ビルドトリガーの YAML 構文
構成 YAML ファイルには、ビルド トリガーの定義が含まれています。オンライン ワークフロー エディターを使用せずに、YAML で直接構成できます。
既存のトリガー構成
このページでは、ワークフローまたはパイプライン内で定義されるターゲットベースのビルド トリガーについて詳しく説明します。よりきめ細かく柔軟なビルド トリガー システムを提供するため、すべての新規ユーザーにはこのアプローチをお勧めします。
既存の構成では、従来のプロジェクトベースのトリガーが使用される場合があります。詳細については、以下を参照してください。 従来のプロジェクトベースのトリガー。
構成 YAML ファイルには、ビルド トリガーの定義が含まれています。オンライン ワークフロー エディターを使用せずに、YAML で直接構成できます。
トリガー構文
トリガーは、 triggers ワークフローまたはパイプライン内の要素。 triggers 要素には、トリガーのタイプと少なくとも 1 つのトリガー条件が含まれます。
例えば、以下のトリガーはコードがプッシュされたときにビルドを起動します。 release 支店。
workflows:
pipeline-tests:
triggers:
push:
- branch: "release"
複数の一致するトリガー
構成 YAML 内のすべてのトリガーを解析し、一致するすべてのトリガーでビルドを開始します。つまり、トリガーの順序は重要ではありません。
たとえば、2つのワークフローがあり、 push 同じトリガー branch 条件では、コミットがそのブランチにプッシュされたときに両方のトリガーがトリガーされます。以下の構成では、コミットがそのブランチにプッシュされたときに両方のトリガーがビルドを開始します。 release 支店:
-
の
pipeline-testsワークフローは、release支店。 -
の
pipeline-buildワークフローの使用 ワイルドカード そのため、どのコミットでもビルドがトリガーされます。
workflows:
pipeline-tests:
triggers:
push:
- branch: "release"
[...]
pipeline-build:
triggers:
push:
- branch: "*"
複数のトリガー条件
複数のトリガー条件を定義した場合、ビルドをトリガーするにはそれらすべてが一致する必要があります。以下の例では、次の場合にビルドがトリガーされます。
-
コミットは
release支店。 -
コミットで特定のファイルが変更されました。
workflows:
pipeline-builds:
triggers:
push:
- branch: release
changed_files: path/to/library-a/.*
ワイルドカードと正規表現
ワイルドカードをサポートしています (*) を使うと、あらゆる種類のトリガー内でテキストを簡単に照合できます。ワイルドカードは、正規表現の高度なパターンマッチング機能が必要ない場合に適しています。たとえば、で始まるコミットメッセージに基づくトリガーなどです fix ワイルドカードを使用して実行できます。の使用をお勧めします pattern これを実現するためのプロパティ:
my_awesome_workflow
triggers:
push:
- branch: main
- commit_message:
pattern: "hello"
代替構文
ワイルドカードパターンをすぐ隣に追加することもできます commit_message フィールド: commit_message: "hello"。この構文は引き続きサポートします。
ワイルドカードは、入力に含まれる特定の固定値を一致させるのに役立ちます。複数の代替値、否定、特定の文字グループまたは特定の文字タイプ (たとえば、数字のみ) のキャプチャが必要な場合は、正規表現を使用することをお勧めします。
トリガー条件に正規表現を使用するには、 regex: その値に:
workflows:
deploy:
triggers:
tag:
- name:
regex: '^\d\.\d\.\d$'
pull_request:
- comment: "[workflow: deploy]"
commit_message:
regex: '.*\[workflow: deploy\].*'
トリガーコンポーネント
|
成分 |
説明 |
許容値 |
デフォルト値 |
|---|---|---|---|
|
|
トリガーのタイプを定義します。ターゲットベースのトリガーのトリガー条件は、これらの要素の子です。 |
該当なし |
該当なし |
|
|
トリガーが現在アクティブかどうかを定義するブール型プロパティ。 |
|
|
|
成分 |
説明 |
デフォルト値 |
|---|---|---|
|
|
ビルドをトリガーするためにコードがプッシュされるリポジトリのブランチ。 |
|
|
|
ビルドをトリガーするコミット メッセージ。 |
|
|
|
変更によってビルドをトリガーするファイルまたはフォルダーへのパス。 |
|
|
|
Bitriseがすべてのコミットメッセージや変更されたファイルをコードプッシュで評価するのか、それとも最新のコミットに属するもののみを評価するのかを定義するbooleanプロパティ。 |
|
|
成分 |
説明 |
デフォルト値 |
|---|---|---|
|
|
プル リクエストが開かれるブランチ。 |
|
|
|
プルリクエストのマージ対象となるブランチ。 |
|
|
|
プルリクエストのラベル。 |
|
|
|
ドラフト プル リクエストがビルドをトリガーするかどうかを定義するブール プロパティ。 |
|
|
|
プルリクエストに投稿されたコメント。 |
|
|
|
プル リクエストへのプッシュ内の特定のコミット メッセージ。 |
|
|
|
プル リクエストで変更される特定のファイル。 |
|
|
成分 |
説明 |
デフォルト値 |
|---|---|---|
|
|
タグの値。文字列値または |
|