メインコンテンツまでスキップ

ビルドトリガーのYAML構文

既存のトリガー設定

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

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

設定YAMLファイルには、ビルドトリガーの定義が含まれています。オンラインのWorkflow Editorを使用しなくても、YAML内で直接設定できます。

トリガーの構文Click to copy link​

トリガーは、WorkflowまたはPipeline内のtriggers要素に含める必要があります。triggers要素内の有効なトリガーには、トリガーのタイプと少なくとも1つのトリガー条件が含まれます。

例えば、以下のトリガーは、releaseブランチにコードがプッシュされたときにビルドを起動します。

workflows:
pipeline-tests:
triggers:
push:
- branch: "release"

複数の一致するトリガーClick to copy link​

設定YAML内のすべてのトリガーを解析し、一致するすべてのトリガーでビルドを開始します。つまり、トリガーの順序は重要ではありません。

例えば、同じbranch条件を持つpushトリガーが設定されたWorkflowsが2つある場合、そのブランチにコミットがプッシュされると両方がトリガーされます。以下の設定では、releaseブランチにコミットがプッシュされると、両方のトリガーがビルドを起動します。

  • pipeline-tests Workflowはreleaseブランチを指定します。
  • pipeline-build Workflowはワイルドカードを使用しているため、どのコミットでもビルドがトリガーされます。
workflows:
pipeline-tests:
triggers:
push:
- branch: "release"
[...]
pipeline-build:
triggers:
push:
- branch: "*"

複数のトリガー条件Click to copy link​

複数のトリガー条件を定義した場合、ビルドをトリガーするにはすべての条件が一致する必要があります。以下の例では、次の場合にビルドがトリガーされます。

  • releaseブランチにコミットがプッシュされた場合。
  • コミット内で特定のファイルが変更された場合。
workflows:
pipeline-builds:
triggers:
push:
- branch: release
changed_files: path/to/library-a/.*

ワイルドカードと正規表現Click to copy link​

すべての種類のトリガー内でのシンプルなテキストマッチングには、ワイルドカード(*)を使用できます。正規表現の高度なパターンマッチング機能が不要な場合は、ワイルドカードが適しています。例えば、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\].*'

トリガーのコンポーネントClick to copy link​

コンポーネント説明使用できる値Default value
pull request push tagトリガーのタイプを定義します。ターゲットベースのトリガーのトリガー条件は、これらの要素の子要素です。該当なし該当なし
enabledトリガーが現在有効かどうかを定義するブール値のプロパティです。- true - falsetrue
コンポーネント説明Default value
branchビルドをトリガーするためにコードがプッシュされるリポジトリのブランチです。*
commit_messageビルドをトリガーするコミットメッセージです。*
changed_files変更によってビルドをトリガーするファイルまたはフォルダーのパスです。*
last_commitBitriseが、コードプッシュ内のすべてのコミットメッセージや変更されたファイルを評価するか、最新のコミットに属するもののみを評価するかを定義するブール値のプロパティです。false
コンポーネント説明Default value
source_branchプルリクエストの作成元となるブランチです。*
target_branchプルリクエストのマージ先となるブランチです。*
labelプルリクエストのラベルです。*
draft_enabledドラフトのプルリクエストでビルドをトリガーするかどうかを定義するブール値のプロパティです。true
commentプルリクエストに投稿されたコメントです。*
commit_messageプルリクエストへのプッシュ内の特定のコミットメッセージです。*
changed_filesプルリクエストで変更される特定のファイルです。*
GitHub スタックされたプルリクエスト

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

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

コンポーネント説明Default value
nameタグの値です。文字列値またはregexプロパティを使用できます。*