モジュラーYAML構成

モジュール構成を作成するには、次の手順が必要です。

で bitrise.yml、これらの追加のYAMLファイルを設定に含めることができます。 include キーワード。1 つのパラメータが必要です: path、これは含める YAML ファイルの場所です。

指定するパスはリポジトリのルートからの相対パスである必要があります。

include:
  - path: file/path/common.yml

ファイルを含むリポジトリを指定することで、別のリポジトリからファイルを取り込むことができます。 repository プロパティを設定する場合は、次のいずれかも設定する必要があります。

リポジトリは、プロジェクトのプライマリリポジトリが属するのと同じGitアカウントまたは組織に属している必要があります。 BitriseプロジェクトのリポジトリURL 例えば、リポジトリのURLが [email protected]:MyOrg/main_repo.git、GitHub 上の MyOrg に属するリポジトリのみを参照できます。

リポジトリの名前を参照するだけで済みます。たとえば、 [email protected]:MyOrg/別のリポジトリ.git 価値を持つ another_repo。

include:
  - path: shared/common.yml
    branch: test_branch
    repository: another_repo

設定モジュールは完全なYAML設定ファイルです。つまり、有効なモジュールのすべての設定要素が bitrise.yml ファイルが利用可能です。 format_version、アプリレベルの環境変数、デフォルトのスタックとマシンタイプ、そしてもちろん構成モジュール内のパイプライン、ステージ、ワークフロー。

例えば、最低限の bitrise.yml 単に別のモジュールを指すファイル:

include:
  - path: path/to/config_module.yml

そしてこの場合、 config_module.yml ビルドの全体的な構成が含まれています:

format_version: 13
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
project_type: android
app:
  envs:
  - MY_NAME: My Name
workflows:
  test:
    steps:
    - script:
        inputs:
        - content: echo "Hello ${MY_NAME}!"

構成モジュールには、ルート レベルで定義された任意の構成エンティティを含めることができます。たとえば、単一のワークフローのみ、またはアプリ レベルの環境変数のみを定義する構成モジュールは完全に有効です。

の bitrise.yml ファイル：

format_version: 13
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
include:
  - path: path/to/config_module.yml

の config_module.yml ファイル：

app:
  envs:
  - USER_NAME: UserName
workflows:
  test:
    steps:
    - script:
        inputs:
        - content: echo "Hello ${USERNAME}!"

ただし、ルート レベル以外のエンティティは、別のモジュール ファイル内で単独で存在することもできません。たとえば、次のようにステップ入力を含めることはできません。

format_version: 13
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
include:
  - path: path/to/config_module.yml

include:
  - path: path/to/another_module.yml

workflows:
  ui_test:
    steps:
    - pull-intermediate-files@1:
        inputs:
        - artifact_sources: build_tests.build_for_ui_testing

format_version: 13
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
project_type: android

include: 
  - path: path/to/config_module.yml

app:
  envs:
  - USER_ID: UserId
  - PASSWORD: SecurePassphrase

format_version: 10

app:
  envs:
  - USERNAME: UserName

workflows:
  test:
    steps:
    - script:
        inputs:
        - content: echo "Hello ${USERNAME}!"

format_version: 13
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
project_type: android

app:
  envs:
  - USER_ID: UserId
  - PASSWORD: SecurePassphrase
  - USERNAME: UserName

workflows:
  test:
    steps:
    - script:
        inputs:
        - content: echo "Hello ${USERNAME}!"