Stepの条件付きでの有効化または無効化
任意のWorkflow内でStepを有効または無効にでき、Stepsの条件を設定することもできます。これは、お使いのコンピューター上でBitrise CLIを使うか、Workflow Editor内のYAMLエディターを使うことで行えます。
これらの操作には主にrun_if式を使用します。使用可能なテンプレート式の例については、run_if式の例を確認してください。
GitHubでも例を確認できます: テンプレート式の例。
run_ifは任意の有効なGoテンプレートで構いませんrun_ifは、trueまたはfalseと評価される限り(あるいは文字列表現、例えばTrue、t、yes、yはすべてtrueとみなされます)、任意の有効なGo templateで構いません。テンプレートがtrueと評価された場合、Stepが実行されます。そうでない場合は実行されません。
カスタムの環境変数を確認するrun_ifの例:
run_if: |-
{{enveq "CUSTOM_ENV_VAR_KEY" "test value to test against"}}
このrun_ifは、CUSTOM_ENV_VAR_KEYの値がtest value to test againstでない場合、Stepをスキップします。
Stepを無効にするClick to copy link
WorkflowからStepを削除したくないが実行はさせたくない場合、run_if式を使用して無効にできます。
Stepsを削除または無効にすることなくWorkflowのさまざまな設定を試すには、Workflowを複製することをお勧めします。複製したWorkflowは、元の設定を変更することなく自由に編集できます。
- Workflow Editor
- Configuration YAML
-
必要なWorkflowを開きます。
-
無効にしたいStepを見つけます。
-
Additional run conditionsの入力欄にfalseと入力します。
条件falseと評価される条件であれば、どのようなものでも機能します。
-
プロジェクトの設定YAMLファイルを開きます。
-
無効にしたいStepを見つけます。
-
そこに
run_if: falseを追加します。条件falseと評価される条件であれば、どのようなものでも機能します。
- script:run_if: falseinputs:- content: |-#!/bin/bashecho "This will never run, because of run_if:false"
CI環境でのみStepを実行するClick to copy link
CI環境でのみStepを実行するということは、ローカルビルドではその特定のStepをスキップすることを意味します。Stepsを無効にする場合と同様に、run_if式を使ってこれを行えます。ローカルでビルドをデバッグする際に使用してください。
CIモードは、お使いのMac/PCでCI環境をtrueに設定するか(例えば、Bashターミナルでexport CI=trueを実行します)、--ciフラグを付けてbitrise local runを実行することで有効にできます: bitrise --ci local run ...。
- Workflow Editor
- Configuration YAML
- 必要なWorkflowを開きます。
- 必要なStepを見つけます。
- Additional run conditionsの入力欄に
.IsCIと入力します。
-
プロジェクトの設定YAMLファイルを開きます。
-
必要なStepを見つけます。
-
そのプロパティに
run_if: .IsCIを追加します:- script:run_if: .IsCIinputs:- content: |-#!/bin/bashecho "This will only ever run in a CI environment because run_if: IsCI"
ビルドが失敗した場合にのみStepを実行するClick to copy link
ビルドがその特定のStepに到達する前に失敗した場合にのみ、Stepを実行することが可能です。run_ifに加えて、is_always_runプロパティも使用する必要があります。
- Workflow Editor
- Configuration YAML
- 必要なWorkflowを開きます。
- 無効にしたいStepを見つけます。
- Additional run conditionsの入力欄に
.IsBuildFailedと入力します。 - Run even if previous Step(s) failedオプションがオンにな っていることを確認します。
-
プロジェクトの設定YAMLファイルを開きます。
-
無効にしたいStepを見つけます。
-
そこに
run_if: .IsBuildFailedを追加します。 -
そこに
is_always_run: trueを追加します。これにより、以前のStepが失敗した場合でもStepを実行できるようになります。
- script:is_always_run: truerun_if: .IsBuildFailedinputs:- content: |-#!/bin/bashecho "Build Failed!"
ビルドを失敗させずに失敗したStepを無視するClick to copy link
通常、ビルド中にStepが失敗すると、ビルド自体も失敗します。キャッシュ、通知、ステータスレポート用のSteps(例えばSave CacheやSlackなど)は、失敗してもビルドを続行できるように、デフォルトで設定されていることがよくあります。他のStepについても、失敗してもビルドが失敗しないように設定できます。
- Workflow Editor
- Configuration YAML
-
Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。
-
メインページの Workflows ボタンをクリックします。
-
設定したいStepをクリックします。
-
When to runの下にあるContinue build even if this Step failsトグルをenable theします。
-
Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。
-
メインページの Workflows ボタンをクリックします。
-
Workflow Editorの上部にあるYAMLに切り替えます。
-
必要なStepを見つけます。
-
is_skippableフラグを追加し、trueに設定します:- script:is_skippable: trueinputs:- content: |-#!/bin/bashecho "Failing Step."exit 1# exit 1 would mark this step as Failed, but it won't break the Build# because of the is_skippable: true flag / property
Script Stepsを使ったrun_if条件の設定Click to copy link
Stepを実行するかどうかを判断するために必要な条件が、複雑で多層にわたる場合があります。その場合、run_if式の中で複雑なGoテンプレートの連鎖を使用するのは、特にGo以外の言語を好む場合、大変になることがあります。
このような場合は、回避策として、Workflow内にScriptStepを追加し、特定の値に評価されるスクリプトを記述することをお勧めします。その値を環境変数に保存すれば、条件式を持つStepはその値を確認するだけで済みます。
run_if式でGo以外のスクリプトを使用するこの例では、簡単なBashスクリプトを作成してその値を保存し、あらかじめ設定した値と一致するかどうかを確認します。
まず、Script Stepを追加し、script content内で値を定義します。値を定義したら、[envman](https://github.com/bitrise-io/envman/)を使用してその値を環境変数に保存します。この例では、Bash内で変数を定義し、その変数をEnv Varの値として使用します:
workflows:
example:
steps:
- script@1:
title: Do anything with Script step
inputs:
- content: |-
#!/usr/bin/env bash
# fail if any commands fails
set -e
# debug log
set -x
# creating the variable and storing it as an Env Var
my_variable='This is the value we need!'
envman add --key OUR_CONDITION --value "$my_variable"
次に、条件が必要なStepに対して、簡単なrun_if式を作成します。この場合、StepはSave cacheStepであり、OUR_CONDITION変数の値が前のBash変数に保存された値と一致するかどうかを確認します:
- save-cache@1:
run_if: |-
{{getenv "OUR_CONDITION" | eq "This is the value we need!"}}
値が一致するため、Save cacheStepが実行されます。
run_if式の例Click to copy link
run_if式の使い方にはさまざまな方法があります。以下のWorkflowには、それらのほとんどの例が、コメントによる説明付きで含まれています。これらの式は、正常に実行されると使用した式がtrueであったことを出力するScriptStepsで使用されています。
すべての式は有効なGoテンプレートです。Goテンプレートについて詳しくは、ドキュメントをご確認ください: Go template docs。
workflows:
primary:
steps:
#
# Check if an Environment Variable's value is equal to a given string
- script:
title: Run-If expression
run_if: |-
{{getenv "TEST_KEY" | eq "test value"}}
inputs:
- content: |-
#!/bin/bash
echo "RunIf expression was true"
#
# Use the enveq function to check if an Env Var's value is equal to a given string
- script:
title: Run-If expression
run_if: '{{enveq "TEST_KEY" "test value"}}'
inputs:
- content: |-
#!/bin/bash
echo "RunIf expression was true"
# Use envcontain to check if the value of an Env Var contains a given string. It works on the level of Pipelines, too
- script:
title: Run-If expression
run_if: '{{envcontain "TEST_KEY" "test value"}}'
inputs:
- content: |-
#!/bin/bash
echo "RunIf expression was true"
#
# Check if a given Env Var is NOT empty
- script:
title: Run-If expression
run_if: '{{getenv "TEST_KEY" | ne ""}}'
inputs:
- content: |-
#!/bin/bash
echo "RunIf expression was true"
#
# Check if two Env Vars have the same value
- script:
title: Run-If expression
run_if: '{{getenv "TEST_KEY_1" | eq (getenv "TEST_KEY_2")}}'
inputs:
- content: |-
#!/bin/bash
echo "RunIf expression was true"
#
# Use the available expression data properties
# like IsCI (checks if the build runs in a CI environment) or IsBuildFailed (checks if the build has failed) directly
- script:
title: Run-If expression
run_if: |-
{{.IsCI}}
inputs:
- content: |-
#!/bin/bash
echo "RunIf expression was true"
#
# You don't have to wrap the expression in {{...}} if it's a simple
# oneliner
- script:
title: Run-If expression
run_if: $.IsCI
inputs:
- content: |-
#!/bin/bash
echo "RunIf expression was true"
#
# You can even remove the $ sign, it's optional in a simple
# expression like this
- script:
title: Run-If expression
run_if: .IsCI
inputs:
- content: |-
#!/bin/bash
echo "RunIf expression was true"
#
# If-Else condition, in this example the Step will run if the build runs in a CI environment
- script:
title: Run-If expression
run_if: |-
{{if .IsCI}}
true
{{else}}
false
{{end}}
inputs:
- content: |-
#!/bin/bash
echo "RunIf expression was true"
#
# You can use multiple conditions
- script:
title: CI and Not Failed
run_if: |-
{{.IsCI | and (not .IsBuildFailed)}}
inputs:
- content: |-
#!/bin/bash
echo "RunIf expression was true"
#
# Check if the build is a pull request or not
- script:
title: Only if NOT a pull request
run_if: not .IsPR
inputs:
- content: |-
#!/bin/bash
echo "RunIf expression was true"
- script:
title: Only if it was a Pull Request
run_if: .IsPR
inputs:
- content: |-
#!/bin/bash
echo "Pull Request ID: ${PULL_REQUEST_ID}"