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

Bitrise Pipelineの設定

Pipelines with stages

Pipelineの設定を2024年12月より前から使用している場合、Pipelineにステージが含まれている可能性があります。ステージの使用を中止し、Workflows間の依存関係を設定することに注力することを強くお勧めします。これらの依存関係により、Pipeline内の実行順序が決まります。これにより、ステージによる不要な待ち時間がなくなり、より柔軟なCIの設定が可能になります。

引き続きステージを使用したPipelinesを使用できますが、今後アップデートは提供されません。同じ設定YAMLファイル内に両方のタイプのPipelinesを含めることができますが、2つのタイプを混在させることはできません。つまり、同じPipeline内にステージとWorkflowの依存関係の両方を含めることはできません。

ステージを使用したPipelinesのドキュメントはこちらでご確認いただけます。Pipelines with stages。

ステージを使用したPipelineは新しい形式に変換できます。Converting a Pipeline with stages into a graph Pipeline。

設定YAMLファイル内のpipelines要素の下でPipelinesを定義できます。Pipelineを設定するには、以下の要素を使用します。

  • Pipeline名: Pipelineの人が読める識別子。
  • workflows要素: Pipelineに含まれるWorkflowsのリストを含みます。
  • depends_onプロパティ: これはworkflows elementのプロパティで、Workflow名の配列を受け入れます。Workflows間の依存関係を定義します。

例として、シンプルなPipelineの設定を示します。

pipeline-example.png

このPipelineでは、4つのWorkflowsがあります。

  1. Workflow Aが最初に実行されます。
  2. Workflow Aが完了すると、Workflows BとCが同時に開始します。
  3. Workflow Dは、Workflows BとCの両方が正常に完了した場合にのみ開始します。

Pipelineの作成Click to copy link​

Workflow Editorを開き、左側のPipelinesを選択します。Create Pipelineをクリックして名前を設定し、もう一度Create Pipelineをクリックします。

最初のWorkflowを追加するには、Workflowsをクリックします。

add-workflow-pipeline.png

この方法でWorkflowsを追加し続けることができます。この方法ではWorkflows間に依存関係は作成されず、すべて同時に実行されます。

basic-pipeline.png

Workflowは1つ以上のWorkflowsに依存させることができます。依存先のWorkflowsのいずれかが失敗すると、Workflowは実行されません。Workflowの依存関係を作成するには、Workflowの右端にカーソルを合わせてプラス記号をクリックします。

add-dependent-workflow.png

この方法で、同じWorkflowに複数の依存Workflowsを追加できます。

multiple-dependent-flows.png

同じWorkflowを2つ以上の異なるWorkflowsに依存させることもできます。プラス記号からPipeline内にすでにある別のWorkflowまでドラッグすることで、パスを作成できます。

drag-and-drop-dep.png

設定の制限Click to copy link​

  • Pipelineに含めることができるWorkflowsは最大200個です。それぞれがルートレベルのworkflows要素の下に存在するWorkflowである必要があります。
  • ユーティリティWorkflowsはPipelineに追加できません。ユーティリティWorkflowsを使用したい場合は、通常のWorkflowの一部として含めてください。
  • 各Workflowは同じPipelineに一度だけ追加できます。同じWorkflowをPipelineの複数の異なる部分に含めることはできません。
  • 依存関係リストで定義されたWorkflowは、すべて同じPipelineに含まれている必要があります。
  • 設定から生成される依存グラフに、循環やループを含めることはできません。無効なPipelineの設定でビルドを開始することはできません。

Pipeline内でのWorkflowの条件付き実行Click to copy link​

run_if式を使用してWorkflowの実行を制御できます。Workflowを実行するかどうかの条件を設定できます。

  1. Pipelineを開きます。

  2. 対象のWorkflowにカーソルを合わせ、歯車アイコンをクリックしてEdit Workflowダイアログを開きます。

    workflow-properties-edit.png

  3. Pipeline Conditionsを選択します。

  4. Additional running conditions入力に、有効なGo templateを追加します。

    この入力は3つのヘルパー関数を受け入れます。

    • getenv: 環境変数の値にアクセスします。
    • enveq: 環境変数を指定した値と比較します。
    • envcontain: 環境変数に指定した文字列が含まれているかどうかを確認します。

    run-if-template.png

  5. Edit Workflowダイアログを閉じ、Save changesをクリックします。

スキップされたWorkflowは成功としてカウントされるため、すべてのWorkflowがスキップされたPipelineは正常に完了し、Gitプロバイダーに緑のステータスを報告します。ドキュメントのみの変更など、ビルドをトリガーすべきでないプルリクエストで必須のステータスチェックに合格させるために、スキップされたWorkflowを使用できます。これを確実に設定する方法については、Passing a required check on documentation-only pull requestsをご覧ください。

Pipeline内で常にWorkflowを実行するClick to copy link​

依存先のWorkflowが失敗した場合でも必ず実行されるように、Workflowをマークできます。

Transitive dependency

Workflowが常に実行されるように設定されていても、依存するWorkflowsが実行されない場合があります。親のWorkflowsのいずれかが失敗した場合、対象のWorkflow自体は実行されますが、依存するWorkflowsは実行されない場合があります。

例えば、Workflow Bに依存するWorkflow Cがあるとします。Workflow BはWorkflow Aに依存しています。3つのWorkflowsのうち、常に実行するよう設定されているのはBのみです。

  • Aが失敗した場合、Bは実行されますが、その結果に関わらず、Bに依存することでAにも依存しているため、Cは実行されません。
  • Cは、AとBの両方が成功した場合にのみ実行されます。
  1. Pipelineを開きます。

  2. 対象のWorkflowにカーソルを合わせ、歯車アイコンをクリックしてEdit Workflowダイアログを開きます。

    workflow-properties-edit.png

  3. Pipeline Conditionsを選択します。

  4. Always run入力をWorkflowに設定します。

    この設定は、1つ以上の親のWorkflowsが失敗した場合でもWorkflowが実行されることを意味します。ただし、依存するWorkflowsは実行されない場合があります。

Workflowの失敗時にPipelineを中止するClick to copy link​

指定したWorkflowが失敗した際にPipelineをすぐに終了するように設定できます。デフォルトでは、Pipelineは終了しません

  1. Pipelineを開きます。

  2. 対象のWorkflowにカーソルを合わせ、歯車アイコンをクリックしてEdit Workflowダイアログを開きます。

    workflow-properties-edit.png

  3. Pipeline Conditionsを選択します。

  4. Abort Pipeline on failure入力をオンに切り替えます。

    対象のWorkflowが失敗すると、Pipelineはすぐに実行を停止します。

Pipelineの優先度Click to copy link​

各Pipelineに優先度を設定できます。優先度の設定は、build queue内でのPipelineビルドの位置を決定します。優先度が高いほど、Pipelineビルドの実行が早くなります。

優先度はWorkflow Editor、またはプロジェクトの設定YAMLファイルのいずれかで割り当てることができます。優先度は常に-100から100までの整数です。数字が大きいほど優先度が高くなります。デフォルトの優先度は0です。

build priorityの詳細、および異なるタイプの優先度間の優先順位については、Build priorityをご覧ください。

Pipeline内でWorkflows間のファイルを共有するClick to copy link​

Pipeline内のWorkflows間でファイルを共有するには、Deploy to Bitrise.ioStepとPull Pipeline intermediate filesStepを使用します。StepはPipelineの中間ファイルをローカルフォルダにダウンロードします。

ファイル共有を設定するには、以下の手順に従います。

  1. 必要なファイルを生成するWorkflowにDeploy to Bitrise.ioStepを追加します。

  2. Pipeline Intermediate File Sharingの入力グループで、Files to share between Pipeline Workflowsの入力を見つけ、以下の構造を使ったコロン区切り項目の改行区切りリストとしてファイルを追加します。<file_or_directory_path>:<environment_variable_key>。

    ファイルパスとして別の環境変数を使用することもできます。例えば、iOSプロジェクトの場合、$BITRISE_IPA_PATH:BITRISE_IPA_PATHは生成されたIPAを他のWorkflowsと共有する有効な方法です。

  3. 生成されたファイルを必要とする任意のWorkflowにPull Pipeline intermediate filesStepを追加します。

  4. Intermediate file sourceの入力を使用して、ファイルが必要なWorkflowsのセットを指定します。

    pipeline-intermediate.png

    入力にはワイルドカードを使用できます。上記の例では、名前がworkflowで始まるすべてのWorkflowsから中間ファイルをすべて取得しています。

  5. Stepが完了すると、Deploy to Bitrise.io - Apps, Logs, ArtifactsStep経由で指定されたファイルとディレクトリが利用可能になります。

詳細については、Step repositoryをご覧ください。

Workflows間で環境変数を共有するClick to copy link​

Share Pipeline variablesStepを使用して、Workflowの環境変数を再利用し、以降のWorkflowsで再利用できます。

Optional Workflows using run_if conditions

Share Pipeline variablesStepをrun_if式と組み合わせることで、オプションのWorkflowsを持つPipelinesを簡単に作成できます。詳細については、Enabling or disabling a Step conditionallyをご覧ください。

これを行うには、以下の手順に従います。

  1. Share Pipeline variablesStepをWorkflowに追加します。

  2. 必要に応じて、Additional run conditions入力でadditional run conditionsを定義できます。Stepは、ここで指定した条件が真の場合にのみ実行されます。

  3. 以降のWorkflowsで使用したい環境変数を、Variables to share between Pipeline Workflows入力に追加します。

    Using environment variable keys

    環境変数は{key}={value}の構文を使用して定義できます。例えば、MY_ENV_KEY=value、またはINSTALL_PAGE_URL=$BITRISE_PUBLIC_PAGE_URLのように指定します。

    デフォルトの環境変数キーを使用したい場合は、省略構文を使用できます。例えば、EXISTING_ENV_KEYのように指定します。

    このStepを使用した環境変数の共有では、アプリで定義済みの既存の環境変数は上書きされません。

同じWorkflowのバリエーションの実行Click to copy link​

並列実行(Parallelism)を使うと、1つの指示でPipeline内の単一のWorkflowの実行を多数のランナーに分割できます。これはテストシャーディングに特に有用です。各シャードごとに定型コードを指定する必要なく、1つのテストWorkflowを複数回再利用できます。実行時、Bitriseは自動的に並列のWorkflowsのセットを作成し、シャード番号とシャードの合計数をenvironment variablesとして提供します。

並列設定を使用して、同じコードベースから複数のホワイトラベルアプリをビルド・テストしたり、同じCIジョブを複数回実行する必要があるその他の目的を達成したりすることもできます。

並列実行の概要Click to copy link​

Graph pipelines only

並列実行は、ステージを含むPipelinesでは利用できません。この機能を利用するには、ステージベースのPipelinesをグラフPipelinesに変換してください。Converting a Pipeline with stages into a graph Pipeline。

parallelプロパティを使用して、Workflowの並列設定を作成できます。Pipelineには、並列設定を持つ複数のWorkflowsを含めることができます。これらのWorkflowsは他のWorkflowsに依存させることができます。Workflowが並列設定を持つWorkflowに依存する場合、Workflowのすべてのコピーの実行に依存することになります。

parallelプロパティは値として整数を取ります。例えば、値が5の場合、Workflowのコピーが5つ実行されます。各コピーは2つの新しいenvironment variablesを受け取ります。

  • $BITRISE_IO_PARALLEL_INDEX: Workflowの各コピーに対するゼロベースのインデックス。
  • $BITRISE_IO_PARALLEL_TOTAL: コピーの総数。

並列実行の設定Click to copy link​

設定するには、以下の手順に従います。

  1. Workflow Editorを開きます。

  2. Pipelineグラフで対象のWorkflowを見つけ、歯車アイコンをクリックしてWorkflowの設定にアクセスします。

  3. ConfigurationタブでParallel copies入力を見つけ、値を設定します。

    Value limitations

    値は固定数でなければなりません。使用できるのは整数のみです。受け入れられる最大値は200です。

    値として環境変数を使用することもできます。これにより、ビルド中にparallel copiesの最適な数を動的に計算できます。

    並列設定を持つWorkflowに別のWorkflowが依存している場合、Workflowのすべてのコピーが成功した場合にのみ実行されます。

PipelinesでサポートされるユースケースClick to copy link​

一般的なiOSとAndroidのユースケースに基づいたPipelineのレシピを用意しています。これらには、ユーザーが実行する必要がある最も頻繁なタスクの一部が含まれています。これらはGitHub repositoryでご確認いただけます。

PipelineのトラブルシューティングClick to copy link​

Pipelineビルドが失敗した場合、主に2つの選択肢があります。