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

bitrise.ymlファイル内のStepデータ

bitrise.ymlファイルで指定するStepのデータや情報は、Stepのデフォルトの定義と比較して変更したいStepのパラメーターです。

Stepの元のインターフェース定義を確認するには、Step ライブラリでチェックできます。Stepのインターフェース定義は、StepLib のsteps ディレクトリにあります。

bitrise.ymlの設定でStep(参照/ID)以外に入力やその他のStepプロパティを指定しない場合、StepはStepの開発者がインターフェース定義で定めたdefault valueを使用して実行されます。

単一のScriptStepを使った例を見てみましょう。これはbitrise local run testを実行すると実行されます。

format_version: '26'
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git

workflows:
test:
steps:
- script:

inputs:リストプロパティを使用して、Stepの入力を指定します。入力はキーと値で構成されます。

インデント

YAML形式ではインデントが非常に重要です。半角スペース2つまたは4つでインデントする必要があり、タブでインデントすることはできません。

format_version: '26'
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git

workflows:
test:
steps:
- script:
inputs:
- content: "echo 'Hello World!'"

Stepに必須の入力がない場合は、入力を指定する必要はありません。必要な数だけ入力に値を指定できます。

Stepの入力値は常に文字列/テキスト値であり、Environment VariablesとしてStepに渡されます。値は、標準のYAMLマルチライン形式を使用してマルチラインにすることもできます。

format_version: '26'
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git

workflows:
test:
steps:
inputs:
- content: |
#!/bin/bash
set -ex
var_to_print='Hello World!'
echo "${var_to_print}"

上記のようにマルチライン値を使用する場合、キーに対して半角スペース2つまたは4つで値をインデントする必要があります。

is_always_runプロパティをtrueに設定することで、直前のStepが失敗した場合でもStepを強制的に実行できます。

format_version: '26'
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git

workflows:
test:
steps:
is_always_run: true
inputs:
- content: "puts 'Hello Ruby!'"
- runner_bin: ruby

titleプロパティを使用して、Stepにわかりやすいタイトルを追加します。

format_version: '26'
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git

workflows:
test:
steps:
title: Print Hello Ruby
is_always_run: true
inputs:
- content: "puts 'Hello Ruby!'"
- runner_bin: ruby