Bitriseパイプラインの構成

The bitrise.yml ファイルには、パイプラインの完全な構成が含まれています。すべてのように bitrise.yml ファイルの場合、最初にフォーマットバージョンとプロジェクトタイプを定義する必要があります。

---
format_version: '8'
default_step_lib_source: 
project_type: android

これは最低限です bitrise.yml 構成。パイプラインを定義するには、パイプライン属性を使用する必要があります。

pipelines:  
  pipeline-successful:
    stages:
    - stage-successful-1: {}
    - stage-successful-2: {}
    - stage-successful-3: {}

この例では、というパイプラインがあります pipeline-successful、連続して実行される3つのステージがあります。これは、 stage-successful-1 正常に終了し、 stage-successful-2 開始します。いずれかのステージが失敗した場合、後続のステージは開始されません。代わりに、パイプラインが中止され、失敗としてマークされます。

各ステージは、 stages 属性。ステージの定義とは、ステージの一部であるワークフローを指定することを意味します。

stages:
  stage-successful-1:
    workflows:
    - test-1: {}
  stage-successful-2:
    workflows:
    - build-1: {}
    - build-2: {}
  stage-successful-3:
    workflows:
    - deploy-1: {}
    - deploy-2: {}

この例では、ステージは test-1、 build-1、 build-2、 deploy-1、 と deploy-2 ワークフロー。

自動ビルドトリガーを設定するには、トリガーマップが必要です。トリガーマップは、ビルドをトリガーするコードイベントを定義します。パイプライン構成では、プッシュ、プルリクエスト、タグなどの特定のコードイベントによってトリガーされるパイプラインを指定する必要があります。

ワークフロー エディターを使用したパイプライン トリガーの構成

この例では、bitrise.yml を使用してパイプライン トリガーを構成することに焦点を当てていますが、ワークフロー エディターの トリガー タブ。

trigger_map:
- push_branch: "pipe"
  pipeline: pipeline-successful

この例では、アプリのリポジトリのパイプブランチにコードをプッシュすると、 pipeline-successful パイプライン。同様の方法で、任意のコードイベントのトリガーを構成できます。コードイベント、ブランチ名またはタグ名、およびそれぞれのパイプラインを指定するだけです。次の属性を使用できます。

トリガーマップを含む、完全に構成されたパイプラインの例を次に示します。

---
format_version: '11'
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
project_type: android
trigger_map:
- push_branch: "*"
  pipeline: pipeline-successful
pipelines:
  pipeline-successful:
    stages:
    - stage-successful-1: {}
    - stage-successful-2: {}
    - stage-successful-3: {}
stages:
  stage-successful-1:
    workflows:
    - successful-20s: {}
  stage-successful-2:
    workflows:
    - successful-20s: {}
    - successful-30s: {}
  stage-successful-3:
    workflows:
    - successful-30s: {}
    - successful-20s: {}
workflows:
  successful-20s:
    steps:
    - script@1:
        title: Print secret1
        inputs:
        - content: |-
            #!/usr/bin/env bash
            set -ex            
            echo $secret1
    - script@1:
        title: Print all env vars
        inputs:
        - content: |-
            #!/usr/bin/env bash
            set -ex            
            printenv
    - script@1:
        title: Wait 20 seconds
        inputs:
        - content: |-
            #!/usr/bin/env bash
            set -ex
            sleep 20
  successful-30s:
    steps:
    - script@1:
        title: Wait 30 seconds
        inputs:
        - content: |-
            #!/usr/bin/env bash
            set -ex
            sleep 30

デフォルトでは、ワークフローの 1 つが失敗したためにステージが失敗した場合、パイプラインの他の後続のステージは実行されません。ただし、パイプラインが中止されない限り、特定のステージを実行するようにパイプラインを構成できます。

これを行うには、設定する必要があります should_always_run ステージの属性をtrueに設定します。

stages:
  stage-always-run-successful-1:
    should_always_run: true
    workflows:
    - deploy-1: {}
    - deploy-2: {}

上記の例では、Stage が呼び出されます。 stage-always-run-successful-1 前のステージのステータスに関係なく、常に実行されます。これらのステージが実行されない唯一の方法は、パイプライン ビルドがユーザーによって中止された場合です。

デフォルトでは、特定のステージのワークフローに障害が発生しても、同じステージの他のワークフローは自動的に中止されません。これらのワークフローは実行されますが、次のステージは開始されません。ただし、この動作を変更して、同じステージ内の他のすべてのワークフローを即座に自動的に中止することができます。

そのためには、を設定する必要があります abort_on_fail に属性 true：

stages:
  stage-abort-on-fail-1:
    abort_on_fail: true
    workflows:
    - deploy-1: {}
    - deploy-2: {}

ワークフローでは、前のステージのワークフローによって生成されたアーティファクトを使用する必要がある場合があります。ステップ中にそれらを使用できるようにするには、 アーティファクトプル ステップ。

    steps:
    ...
    - deploy-to-bitrise-io@2:
        inputs:
        - pipeline_intermediate_files: |-
            BITRISE_TEST_BUNDLE_PATH
            $BITRISE_IPA_PATH:BITRISE_APP_STORE_IPA_PATH

から任意の環境変数を再利用できます。 ワークフロー その後で再利用します ステージ を使用して パイプライン変数を共有するステップ.このステップを使用して環境変数を共有しても、 アプリ.

そうするために：

それでおしまい！後続のステージで環境変数を使用できるようになりました!

オプションのワークフローは パイプライン かどうかを決定できる機能 ワークフロー で設定した条件に基づいて実行するかどうか run_if 表現。

他のパイプライン機能と同様に、この機能は bitrise.yml.

の中に bitrise.yml、 下 stages/workflows フィールドに追加できます run_if 任意のワークフローへの式であり、それらがパイプライン ビルドの一部である場合、 run_if ワークフローを実行するかどうかを決定するために評価されます。

format_version: '11'
envs:
  FOO: 'BAR'
pipelines:
  pipeline1:
    stages:
    - stage1: {}
stages:
  stage1:
    workflows:
    - workflow-never-run:
        run_if: '{{ false }}'
    - workflow-always-run:
        run_if: '{{ true }}'
    - workflow-optionally-dont-run:
        run_if: '{{ getenv "FOO" | eq "notBAR" }}'
    - workflow-optionally-run:
        run_if: '{{ getenv "FOO" | eq "BAR" }}'
workflows:
  workflow-never-run: {}
  workflow-always-run: {}
  workflow-optionally-dont-run: {}
  workflow-optionally-run: {}