構成YAMLリファレンス
このドキュメントでは、BitriseでCI/CDの設定を定義する設定YAMLファイルの設定オプションについて説明します。
- 設定YAMLファイルの基本原則については、概要をご確認ください: 設定YAMLの概要。
- 設定YAMLファイルの保存場所についてRead more: プロジェクトの設定YAMLファイルの管理。
- 高度なモジュール式設定を作成する: モジュール式YAML設定。
プロジェクトレベルのプロパティClick to copy link
format_versionClick to copy link
Required: 設定YAMLファイルには、これがないと無効になります。
Bitrise設定フォーマットのバージョンです。
Bitrise CLIは、設定ファイルとCLIのバージョン間の互換性を確認するためにこれをチェックします。これはローカルで実行するビルドに関係します。Bitrise website上ではCLIが常に最新の状態であるため、トリガーされたビルドに対してformat_versionプロパティは影響しません。
format_versionのExample
format_version: '25'
default_step_lib_sourceClick to copy link
設定内で使用するStepsのデフォルトのStepライブラリです。特定のStepにソースが指定されていない場合、Bitriseはこのソースを使用します。
default valueはhttps://github.com/bitrise-io/bitrise-steplib.git.このリポジトリの独自のフォークをStepのソースとして使用することも、正確なソースリポジトリを指定してStepsを参照することもできます: Stepのリファレンス/ID形式。
default_step_lib_sourceのExample
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
project_typeClick to copy link
ios、android、flutterなど、Bitriseプロジェクトの種類です。
プロジェクトタイプはいつでも変更できますが、初期セットアップ後は特に意味を持ちません。
project_typeのExample
project_type: flutter
titleClick to copy link
Bitrise設定のタイトルです。
titleのExample
title: My Bitrise project
summaryClick to copy link
Bitrise設定の簡単な概要です。
summaryのExample
summary: This project runs tests for my app.
descriptionClick to copy link
Bitrise設定の詳細な説明です。
descriptionのExample
description: This project runs unit and UI tests when a pull request is opened to the dev branch.
servicesClick to copy link
Linuxホスト上でサービスコンテナとしてStepsが使用するDockerコンテナの定義です。
これはLinuxstacksでのみサポートされています。macOSスタックでは、このプロパティは機能しません。
Stepsのグループに対して1つ以上のサービスを設定でき、高度な統合テストのためにDockerコンテナをサービスとして実行できます。これらはwithグループのライフサイクルに紐付いており、バックグラウンドでそのグループとともに実行されます。グループ内のStepsがすべて終了すると、クリーンアップされます。
以下を定義する必要があります:
- with group内でサービスを参照するために使用する、サービスのID。
- サービスのイメージ名。
- サービスのイメージバージョン。
詳細: サービスコンテナ。
servicesのExample
services:
postgres:
image: postgres:16
envs:
- POSTGRES_USER: postgres
- POSTGRES_DB: bitrise
ports:
- 5432:5432
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
redis:
image: redis:7
ports:
- 6379:6379
options: >-
--health-cmd "redis-cli ping"
--health-interval 10s
--health-timeout 5s
--health-retries 5
containersClick to copy link
Stepsが実行コンテナとして使用するDockerコンテナの定義です。
Dockerコンテナは、設定YAMLファイル内の任意のBitrise projectに対して定義できます。コンテナはファイルのトップレベルで定義し、Workflow設定内のwithグループから参照します。以下を定義する必要があります:
- コンテナのID。このコンテナを参照する際に使用します。
- 使用するDockerイメージの名前。
- イメージのバージョン。
containers reference: Dockerコンテナのプロパティ。
詳細: 実行コン テナ。
containersのExample
containers:
node-21:
image: node:21.6
appClick to copy link
このプロパティには、Environment Variablesなど、プロジェクトレベルの設定情報が含まれます。
ビルドスタックなどのメタ情報はここではなく、metaプロパティに属します。
appのExample
app:
envs:
- TEST: ''
opts:
is_expand: false
metaClick to copy link
Bitrise設定に関連するプロジェクトメタデータのキーと値のペアを保存します。特に、プロジェクトのデフォルトスタックとbuild machineタイプを定義します。
metaのExample
meta:
bitrise.io:
stack: linux-docker-android-22.04
machine_type_id: g2.linux.2medium
trigger_mapClick to copy link
プロジェクトレベルでビルドトリガーを定義します。これはトリガーを設定するレガシーな方法です。PipelineまたはWorkflow内で定義されたターゲットベースのトリガーを使用することをお勧めします。
詳細: レガシーなプロジェクトベースのトリガー。
trigger_mapのExample
trigger_map:
- pull_request_source_branch: "*"
type: pull_request
workflow: primary
pipelinesClick to copy link
プロジェクトの設定内でPipelinesを定義します。Pipelinesを使用すると、CI/CDプロセス全体を整理し、複数の異なるタスクを並列や順次で実行する高度な設定をセットアップできます。
pipelinesリファレンス: Pipelineレベルのプロパティ。
詳細: Pipelinesについて。
pipelinesのExample
pipelines:
test:
title: Test Pipeline
summary: This Pipeline runs unit tests.
workflows:
primary: {}
workflowsClick to copy link
設定に含まれるWorkflowsです。Workflowは再利用可能で設定可能な作業単位であるStepsの集合です。StepsはWorkflow内で順次実行されます。
workflowsリファレンス: Workflowレベルのプロパティ。
workflowsのExample
workflows:
primary:
steps:
- script: {}
step_bundlesClick to copy link
Step bundlesを使用すると、複数のStepsを1つの単位にまとめられます。Step bundlesを使用すると、Stepsや一連のStepsを再利用できます 。
Step bundlesは任意のWorkflowに挿入できます。ユーティリティWorkflowsやWorkflowチェーンとは異なり、Step BundlesはWorkflow内のどこにでも配置できます。
step_bundlesリファレンス: Step bundleのプロパティ。
詳細: Step bundles。
step_bundlesのExample
step_bundles:
primary:
steps:
- git-clone: {}
- restore-cache: {}
includeClick to copy link
includeプロパティを使用すると、Bitrise設定内で他の設定YAMLファイルを使用し、大規模で複雑なYAMLファイルをより小さくモジュール化されたコンポーネントに分割できます。
モジュール式のYAML設定には、以下が含まれます:
- リポジトリのルートにある
bitrise.ymlファイル。 - 同じまたは別のリポジトリにある他のYAMLファイル。別のリポジトリからファイルをインクルードするには、そのリポジトリがプライマリリポジトリと同じGitアカウントまたは組織に属している必要があります。
- bitrise.ymlファイル内の1つ以上の
includeキーワード。これらは他のYAMLファイルを指し示し、そのファイルの設定をメインのプロジェクト設定に取り込みます。
詳細: モジュール 式YAML設定。
includeのExample
include:
- path: path/to/config_module.yml
toolsClick to copy link
セットアップするツールのバージョンです。バージョンの構文は以下をサポートします:
- 正確なバージョン: 例、
'1.2.3'。 - 最新リリースへの部分一致: 例、
'22:latest'。 - インストール済みバージョンへの部分一致: 例、
'1.2:installed'。 - 最新バージョンまたはインストール済みの最上位バージョンを選択する特別なエイリアス
'latest'と'installed'。
詳細: ツールバージ ョンの設定。
toolsのExample
tools:
nodejs: 22:installed
ruby: 3.3:latest
PipelineレベルのプロパティClick to copy link
pipelines:<pipeline-ID>:titleClick to copy link
Pipelineのタイトルです。
これはPipelineのIDとは異なります。IDはPipelineの作成時に設定します。IDとは異なり、タイトルは一意である必要はありません。PipelinesセクションのWorkflow EditorUIに表示されます。Pipelineセレクターのドロップダウンメニューを開いた場合です。
pipelines:<pipeline-ID>:titleのExample
pipelines:
test:
title: Test pipeline
pipelines:<pipeline-ID>:summaryClick to copy link
Pipelineの簡単な概要です。省略可能です。
pipelines:<pipeline-ID>:summaryのExample
pipelines:
test:
summary: This Pipeline runs unit tests.
pipelines:<pipeline-ID>:descriptionClick to copy link
Pipelineの詳細な説明です。省略可能です。
pipelines:<pipeline-ID>:descriptionのExample
pipelines:
test:
description: 'This Pipeline runs unit tests in parallel, using test sharding.'
pipelines:<pipeline-ID>:triggersClick to copy link
Pipelineに対して定義されたターゲットベースのトリガーです。コードイベントがトリガーで定義された条件に一致すると、BitriseはPipelineでビルドをトリガーします。
triggersプロパティの詳細な構文と使用可能なオプションについては、以下をご確認ください:
詳細: ビルドトリガーのYAML構文。
pipelines:<pipeline-ID>:triggersのExample
この例では、mainブランチにプッシュされたコミットがPipelineのビルドをトリガーします。
pipelines:
test:
triggers:
push:
- branch: main
pipelines:<pipeline-ID>:status_report_nameClick to copy link
ビルドが終了した後に、接続されたサービス(GitHub、GitLab、Bitbucketなど)に送信されるステータスレポートに表示される名前です。
静的な値と動的な値の両方を設定でき、両方のタイプを組み合わせることもできます。
Supportedの文字と変数:
A-Za-z,.():/-_0-9 []|<><project_slug>: プロジェクトの一意の識別子。<project_title>: プロジェクトの省略可能なタイトル。<target_id>: トリガーされたWorkflowまたはPipelineのID。<event_type>: ビルドをトリガーしたコードイベント:PR/push/tag。
最大長は100文字です。
pipelines:<pipeline-ID>:status_report_nameのExample
pipelines:
test:
status_report_name: ci/bitrise/510526/push
pipelines:<pipeline-ID>:workflowsClick to copy link
Pipeline設定の一部であるWorkflowsです。
depends_onプロパティを使用して、Workflows間の依存関係を作成できます。
pipelines:<pipeline-ID>:workflowsのExample
pipelines:
test:
workflows:
primary:
pipelines:<pipeline-ID>:priorityClick to copy link
優先度の設定により、build queue内でのPipelineビルドの位置が決まります。優先度が高いほど、Pipelineのビルドは早く実行されます。
Supported values:- -100から100までの整数。
pipelines:<pipeline-ID>:priorityのExample
pipelines:
test:
priority: 10
Pipelines内のWorkflowsのプロパティClick to copy link
workflows:depends_onClick to copy link
このプロパティは、このWorkflowが依存するWorkflowsを定義します。リスト内のWorkflowsのいずれかが失敗した場合、このWorkflowは実行されません。
依存するWorkflowsをリストするには、YAML配列構文の両方のタイプ(ブロックシーケンスとフローシーケンス)を使用できます。依存関係リストに現れるWorkflowは、すべて同じPipelineに属している必要があります。
設定から生成される依存関係グラフに、循環や無限ループを含めることはできません。無効なPipeline設定でビルドを開始することはできません。
Supported values: YAML配列構文を使用したWorkflowの名前。
詳細: Bitrise Pipelineの設定。
workflows:depends_onのExample
ブロックシーケンス配列構文:
pipelines:
example:
workflows:
A: {}
B:
depends_on:
- A
C:
depends_on:
- A
D:
depends_on:
- B
- C
フローシーケンス配列構文:
D:
depends_on: [B, C]
workflows:abort_on_failClick to copy link
このプロパティがtrueの場合、このWorkflowが失敗するとPipelineおよび他の実行中のWorkflowsは中断されます。
Supported values: ブール値
詳細: Bitrise Pipelineの設定。
workflows:abort_on_failのExample
この例では、AとBの両方が並列で実行されています。Bが失敗すると、Workflow Aを含むPipeline全体が直ちに中断されます。
pipelines:
example:
workflows:
A: {}
B:
abort_on_fail: true
workflows:should_always_runClick to copy link
このプロパティは、前のWorkflowが失敗した場合にWorkflowを実行するかどうかを定義します。
推移的な依存関係に注意してください。常に実行するよう設定されたWorkflowに、失敗する親Workflowがある場合でも、それは実行されます。ただし、それに依存するWorkflowsは実行されません。例えば、Workflow Bに依存するWorkflow Cがあるとします。Workflow BはWorkflow Aに依存しています。3つのWorkflowsのうち、常に実行するよう設定されているのはBのみです。
- Aが失敗した場合、Bは実行されますが、その結果に関わらず、Cは実行されません。CはBに依存することで、Aにも依存しているためです。
- Cは、AとBの両方が成功した場合にのみ実行されます。
off: 親Workflowが失敗すると、Workflowは実行されません。これがdefault valueです。workflow: 親Workflowが失敗しても、Workflowは実行されます。
workflows:should_always_runのExample
pipelines:
example:
workflows:
A: {}
B:
depends_on: [ A ]
should_always_run: workflow
C:
depends_on: [ B ]
D:
depends_on: [ C ]
should_always_run: workflow
workflows:run_ifClick to copy link
Workflowを実行する条件を定義するGoテンプ レート式です。
このプロパティには、3つのヘルパー関数を含むGoテンプレートを格納するexpressionフィールドが必要です:
getenv: 環境変数の値にアクセスします。enveq: 環境変数を指定した値と比較します。envcontain: 環境変数に指定した文字列が含まれているかどうかを確認します。
Bitrise CLIは、実行時にこの式を評価します。run_if式によってWorkflowがスキップされた場合、それは成功したWorkflowとしてカウントされ、それに依存するWorkflowsが実行されます。
詳細: run_if式の例。
workflows:run_ifのExample
この例では、BはEXAMPLE_KEY環境変数の値がexample valueの場合にのみ実行されます。
pipelines:
example:
workflows:
A: {}
B:
run_if:
expression: {{ enveq "EXAMPLE_KEY" "example value" }}
depends_on: [A]
workflows:parallelClick to copy link
parallelプロパティを使用すると、1つの命令で同じWorkflowのコピーを並列で実行できます。これはテストシャーディングに特に役立ちます。
このプロパティは、並列で実行するコピーの数を決定します。各コピーは2つの新しいenvironment variablesを受け取ります:
- $BITRISE_IO_PARALLEL_INDEX: Workflowの各コピーに対する0から始まるインデックス。
- $BITRISE_IO_PARALLEL_TOTAL: コピーの総数。
Supported values: 1から200までの整数。
詳細: Pipelinesの並列実行。
WorkflowレベルのプロパティClick to copy link
workflows:<workflow-id>:titleClick to copy link
Workflowのタイトルです。
これはWorkflow EditorのUIに表示されます。
workflows:<workflow-id>:titleのExample
workflows:
primary:
title: Primary Workflow
workflows:<workflow-id>:summaryClick to copy link
Workflowの簡単な概要です。
workflows:<workflow-id>:summaryのExample
workflows:
primary:
summary: This Workflow runs unit tests.
workflows:<workflow-id>:descriptionClick to copy link
Workflowの詳細な説明です。
workflows:<workflow-id>:descriptionのExample
workflows:
primary:
description: This Workflow runs unit tests with test sharding, and exports the test results to the test reports page.
workflows:<workflow-id>:triggersClick to copy link
Workflowに対して定義されたターゲットベースのトリガーです。コードイベントがトリガーで定義された条件に一致すると、BitriseはWorkflowでビルドをトリガーします。
各トリガーは、コードイベントと少なくとも1つの条件を定義します。1つのトリガーに複数の条件を定義した場合、ビルドをトリガーするにはそのすべてが一致する必要があります。
triggersプロパティの詳細な構文と使用可能なオプションについては、以下をご確認ください:
詳細: ビルドトリガーのYAML構文。
workflows:<workflow-id>:triggersのExample
この例では、以下の場合にビルドがトリガーされます:
mainブランチにコミットがプッシュされた場合。- 任意のブランチからプルリクエストが作成された場合。
workflows:
primary:
triggers:
push:
- branch: main
pull_request:
- source_branch: "*"
workflows:<workflow-id>:status_report_nameClick to copy link
ビルドが終了した後に、接続されたサービス(GitHub、GitLab、Bitbucketなど)に送信されるステータスレポートに表示される名前です。
静的な値と動的な値の両方を設定でき、両方のタイプを組み合わせることもできます。
Supportedの文字と変数:
A-Za-z,.():/-_0-9 []|<><project_slug>: プロジェクトの一意の識別子。<project_title>: プロジェクトの省略可能なタイトル。<target_id>: トリガーされたWorkflowまたはPipelineのID。<event_type>: ビルドをトリガーしたコードイベント:PR/push/tag。
最大長は100文字です。
workflows:<workflow-id>:status_report_nameのExample
workflows:
test:
status_report_name: ci/bitrise/510526/push
workflows:<workflow-id>:before_runClick to copy link
これはレガシー機能です。代わりにStep bundlesを使用することをお勧めします: Step bundles。
このWorkflowが開始する前に実行されるWorkflowsです。
このプロパティとafter_runを使用して、Workflowsのチェーンを作成します。
詳細: Workflows同士のチェーン。
workflows:<workflow-id>:before_runのExample
この例では、deployWorkflowの前にtestWorkflowが実行される設定を作成します。
workflows:
test:
steps:
# test Steps
deploy:
before_run:
- test
steps:
# deploy Steps
workflows:<workflow-id>:after_runClick to copy link
これはレガシー機能です。代わりにStep bundlesを使用することをお勧めします: Step bundles。
このWorkflowが正常に終了した後に実行されるWorkflowsです。
このプロパティとbefore_runを使用して、Workflowsのチェーンを作成します。
詳細: Workflows同士のチェーン。
workflows:<workflow-id>:after_runのExample
この例では、ciWorkflowの後にdeployWorkflowが実行される設定を作成します。
workflows:
deploy:
steps:
# deploy Steps
ci:
after_run:
- deploy
steps:
# CI Steps
workflows:<workflow-id>:envsClick to copy link
Workflowに対して定義されたEnvironment Variablesです。
各環境変数はキーと値のペアです。Environment Variablesは値として他のEnvironment Variablesを使用できます: 環境変数の値で環境変数を使用する。
これらの変数は、選択したWorkflowでのみ使用できます。同じ設定YAMLファイル 内で定義された他のWorkflowsからはアクセスできません。プロジェクトレベルのEnvironment variablesの方が優先度が高くなります: Environment Variablesの使用可能順序。
workflows:<workflow-id>:envsのExample
workflows:
primary:
envs:
- TEST: test
- ENV_LABEL: dev
opts:
is_expand: false
workflows:<workflow-id>:stepsClick to copy link
Workflow内のStepsのリストです。
Step参照の基本構文は<step_lib_source>::<step-id>@<version>:です。Step IDは常に必須で、ソースとバージョンは省略可能です。
- ソースを設定しない場合は、
default_step_lib_sourceが使用されます: プロジェクトレベルのプロパティ。 - バージョンを設定しない場合は、latest versionが使用されます。
詳細:
workflows:<workflow-id>:stepsのExample
この例では、正確なソースを指定せず、メジャーバージョン1のlatest versionを使用しています。
workflows:
steps:
- script: {}
この例では、Stepのソースを指定しています。
workflows:
steps:
- https://github.com/bitrise-io/bitrise-steplib.git::script@1: {}
workflows:<workflow-id>:priorityClick to copy link
優先度の設定により、build queue内でのWorkflowビルドの位置が決まります。優先度が高いほど、Workflowのビルドは早く実行されます。
Supported values: -100から100までの整数。
詳細: Build priority。
workflows:<workflow-id>:priorityのExample
workflows:
primary:
priority: 10
workflows:<workflow-id>:toolsClick to copy link
ビルドで使用するツールバージョンの宣言的な設定です。
特定のWorkflowsに対してツールバージョンを定義できます。設定のトップレベルでtoolsプロパティを定義する代わりに、1つ以上のWorkflowsの下にネストして定義します。
バージョンの構文は以下をサポートします:
- 正確なバージョン: 例、
'1.2.3'。 - 最新リリースへの部分一致: 例、
'22:latest'。 - インストール済みバージョンへの部分一致: 例、
'1.2:installed'。 - 最新バージョンまたはインストール済みの最上位バージョンを選択する特別なエイリアス
'latest'と'installed'。
詳細: ツールバージョンの設定。
workflows:<workflow-id>:toolsのExample
workflows:
primary:
tools:
nodejs: 22:installed