- Bitriseドキュメントへようこそ!
- 参考文献
- 構成YAMLの基本
構成YAMLの基本
The bitrise.yml
ファイルはBitrise構成の中心です。 Bitrise CLIは、ローカルまたは当社のWebサイトでBitriseビルドを実行できるようにするためにこのファイルを必要とします。
Bitriseの設定は1つ以上のYAMLファイルで定義されます。 ビットライズCLI ローカルまたは当社のウェブサイトで Bitrise ビルドを実行できるようにするには、設定 YAML ファイルが必要です。
デフォルトの設定YAMLファイルは bitrise.yml
. 必要最低限の bitrise.yml
次のように簡単です:
format_version: 11
上記の構成は有効ですが、実行するものは何も含まれていません run
。
あなたができる最小限の構成 bitrise run
:
format_version: 5 workflows: test:
上記の構成は、次のコマンドで実行できます。 bitrise run test
。 Bitrise CLIはエラーを表示しませんが、実行するように宣言されたものはまだありません。
シングルを実行する例を続けましょう 脚本 ステップ あなたがそれを実行するとき bitrise run test
。
format_version: 11 default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git project_type: android app: envs: - MY_NAME: My Name workflows: test: steps: - [email protected]: inputs: - content: echo "Hello ${MY_NAME}!"
このサンプル構成の簡単な説明:
-
format_version
:BitriseCLI形式の最小バージョンを宣言します。 BitriseCLIでサポートされている最高のフォーマットバージョンを入手してくださいbitrise version --full
。フォーマットバージョン番号
フォーマットバージョン番号は、どのBitriseCLIバージョンが構成を実行できるかを決定します。たとえば、
format_version
に11
つまり、フォーマットバージョンをサポートしていないBitriseCLIバージョン11
以上の場合、構成を実行できません。これは、古いBitriseCLIバージョンでは使用できない機能を使用する場合に重要です。 -
default_step_lib_source
:ステップに他のソースが定義されていない場合に使用するソースを指定します。 -
project_type
:ソースプロジェクトのタイプを定義します(たとえば、android
、ios
、flutter
)。 -
app
-envs
:を指定します 環境変数 (Env Var)これは、すべてのビルド、ワークフロー、およびステップで使用できます。 -
workflows
:は、で実行できる個別のビルド構成のコレクションです。bitrise run WORKFLOWID
。この例では、唯一のワークフローは
test
、で実行できますbitrise run test
。と呼ばれる2番目のワークフローがある場合main
、両方を実行できますbitrise run test
とbitrise run main
。 -
steps
:リスト ステップ これは、ワークフローの実行時に実行する必要があります。この例では、
test
ワークフローには1つだけが含まれますscript
ステップ。複数のステップが宣言されている場合、それらは1つずつ実行されます。 -
[email protected]
:実行するステップ(参照)。この参照にはStepLibSource宣言がありません。つまり、default_step_lib_source
StepLibソースとして使用されます。 -
inputs
:ステップ入力を指定します。複数の入力
ステップには多くの入力を含めることができます。設定または上書きするbitrise.ymlの入力のみを指定します。
-
content
:設定したい入力。この例では、スクリプトステップの内容を指定しました。
-
echo "Hello ${MY_NAME}!"
: これは 価値 に指定しましたcontent
入力。
bitrise.ymlのサイズ制限
でワークフローを編集する場合 bitrise.io (どちらかで ワークフローエディター または bitrise.yml タブ)とあなたの bitrise.yml
サイズ制限を超えると、変更を保存しようとするとUIに次の警告が表示されます。
Error saving! Error saving app config: Validation failed: App config validation 784: unexpected token at 'Argument list too long - bin/bitrise
これは、合計サイズが bitrise.yml
そしてその bitrise.secrets.yml
ファイルは400KBを超えることはできません。