Secretsのローカルでの管理

ローカルでビルドを実行する場合、Bitrise CLIを使うと、Secretsは.bitrise.secrets.ymlファイルから読み込まれます。このファイルは、bitrise.ymlが置かれているディレクトリ、つまりbitrise local runコマンドを実行するディレクトリと同じ場所にあることが想定されています。

Secretsを別の場所に保存したい場合は、bitrise local runコマンドの--inventoryフラグでSecretsファイルの場所を指定できます。例: .

bitrise local run my-workflow --inventory /path/to/secrets.yml

Secretsファイルは必ずgitignoreしてください

ベストプラクティスとして、.bitrise.secrets.ymlが.gitignoreに追加されていることを必ず確認し、リポジトリにコミットされないようにしてください。.bitriseで始まるものをすべてgitignoreするのが最善です。これは、.gitignoreファイルに次の行を追加することで実現できます: .bitrise*

Secrets YAMLファイルには、ルートのenvs:項目と、それに続くSecret Environment Variablesのリストを含める必要があります。

envs:
- SECRET_ENV_ONE: first Secret value
- SECRET_ENV_TWO: second Secret value

.bitrise.secrets.ymlファイルで定義されたSecretsは、他の環境変数と同様に使用できます。

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

workflows:
  test:
    steps:
    - [email protected]:
        inputs:
        - content: |
            #!/bin/bash
            echo "SECRET_ENV_ONE: ${SECRET_ENV_ONE}"
            echo "SECRET_ENV_TWO: ${SECRET_ENV_TWO}"

ディレクトリ内でbitrise local run testするだけで、Script Stepがsecretsファイルで指定された値を出力します。

SECRET_ENV_ONE: first secret value
SECRET_ENV_TWO: second secret value

bitrise local runコマンドを実行するときに最初に処理されるのはSecretsEnvironment Variablesであるため、bitrise.ymlのどこでもSecretsを使用できます。