環境変数

ユーザーは、3 つの異なるレベルで環境変数を宣言できます。

ユーザーが宣言した環境変数に加えて、Bitrise CLI または bitrise.io によって自動的に公開される環境変数があります。これらは、どのビルドでも常に使用できます。これらのリストは次の場所にあります。 利用可能な環境変数

アプリ レベルの環境変数 特定のアプリのすべてのビルドで使用できます。たとえば、新しいワークフローを作成すると、すぐに、すべてのアプリ レベルの環境変数に自動的にアクセスできるようになります。

ワークフロー レベルの環境変数 定義された特定のワークフローでのみ使用できます。 primary ワークフローには、キーを持つ環境変数があります TEST_ENV、 君の deploy ワークフローはその環境変数にアクセスできません。

ステップ レベルの環境変数 ビルドの特定のステップ内で定義されます。このような環境変数は、他のワークフローや、同じワークフロー内の前のステップでは使用できません。ただし、後続のステップはそれにアクセスできます。ステップ出力は、環境変数としても公開されます。

レベルに関係なく、ワークフロー エディターとアプリの両方で環境変数を設定できます。 bitrise.yml ファイル、またはカスタム スクリプトを使用したビルド中に、 環境人 道具：

環境変数には、そのレベルに基づいて特定の処理順序があります。 環境変数の可用性の順序

環境変数（Env Var）は、EnvVarが処理された後に使用可能になります。

BitriseCLIによって公開されたEnvVarがあります。これらは最初から利用できます：たとえば、 BITRISE_SOURCE_DIR と BITRISE_TRIGGERED_WORKFLOW_ID。

他のすべてのEnvVarは処理され、ビルドが進むにつれて利用できるようになります。

処理順序は次のとおりです。

新しい環境変数（環境変数）を設定するには：

それでおしまい。新しいEnvVarが保存され、使用できるようになります。

すべての環境変数には、 is_expand 財産。 UI では、これは次のように表されます。 入力内の変数を置き換えますか? トグル。そうでない限り、これを有効にすることはお勧めしません。 環境変数またはシークレットの値が別の環境変数またはシークレットです。

このオプションを切り替えると、Env Varのキーの代わりに、EnvVarの値がビルドに渡されます。通常、これは必要ありません。

新しい環境変数を直接追加する場合は、 bitrise.yml ファイルを設定しないでください。 is_expand プロパティのデフォルト値は次のようになります true。明示的に設定することをお勧めします is_expand この場合：

envs:
  - opts:
      is_expand: false
      KEY: VALUE

新しいビルドをスケジュールする場合、または新しいビルドを手動で開始する場合は、カスタム環境変数（Env Var）を設定するオプションがあります。これらの変数は、開始またはスケジュールしたビルドでのみ使用できます。

多くの ステップ入力 環境変数（環境変数）を受け入れ、 秘密 入力値として。

Env VarまたはSecretをステップ入力値として使用するには：

それでおしまい。次にそのワークフローのビルドを実行するとき、ステップ入力は挿入されたEnv変数の値をステップ入力値として使用します。

環境変数（Env Var）には通常、単純な文字列値が含まれています。ただし、他のEnvVarを値として含むEnvVarを設定することは可能です。

いつでも、Env Varの値に別の環境変数を使用できます。いわば、EnvVarを埋め込みます。たとえば、の値を設定するとします。 $BITRISE_AUTH Env Var to $PERSONAL_ACCESS_TOKEN これは別のEnv変数です。

これを行うには、次のキーを確認する必要があります $BITRISE_AUTH ワークフローとステップに渡される埋め込みEnv変数になるように、その値に置き換えられます。

ステップで環境変数を定義することにより、ビルド中に環境変数を設定できます。 脚本 ステップ。これを行うには、 環境人 道具。

これは、私たちが使用している簡単な例です envman キーで新しい環境変数を追加するには MY_RELEASE_NOTE:

envman add --key MY_RELEASE_NOTE --value "This is the release note"

あなたは呼び出すことができます envman を含む任意のステップで 脚本 ステップ、または独自のスクリプト (リポジトリに保存されている) で呼び出す場合は、 bitrise 建てる。

値を次のように指定できます --value パラメータ、またはパイプを使用して：

echo 'hi' | envman add --key MY_RELEASE_NOTE

ファイルから値を読み取ることもできます。

envman add --key MY_RELEASE_NOTE --valuefile ./some/file/path

Env Varが公開されると、他のEnvVarと同じように使用できます。これらの公開されたEnv変数は、他のステップの入力でも使用できます。

これは、リリース ノートの環境変数を公開し、それを別の環境変数で使用する例です。 脚本 ステップイン Slack メッセージを送信する ステップ：

workflows:
  example:
    steps:
    - script:
        inputs:
        - content: |
            #!/bin/bash
            envman add --key MY_RELEASE_NOTE --value "This is the release note"
    - script:
        inputs:
        - content: |
            #!/bin/bash
            echo "My Release Note: $MY_RELEASE_NOTE"
    - slack:
        inputs:
        - channel: ...
        - webhook_url: ...
        - message: "Release Note: $MY_RELEASE_NOTE"

別のEnvVarのキーを介してアクセスできるようにEnvVarの値を公開する場合は、そうすることができます。

たとえば、の値を公開するには BITRISE_BUILD_NUMBER キーの下 MY_BUILD_NUMBER：

 envman add --key MY_BUILD_NUMBER --value "${BITRISE_BUILD_NUMBER}"

この後、後続のステップはの値を取得できます BITRISE_BUILD_NUMBER から MY_BUILD_NUMBER 環境変数の値を変更した場合 BITRISE_BUILD_NUMBER この後、の値 MY_BUILD_NUMBER 変更されることはなく、元の値を保持します。

カスタムEnvVarが定義されているかどうかを知る必要がある場合は、簡単に確認でき、値を上書きすることもできます。

#!/bin/bash
set -ex
if [ ! -z "$API_PROJECT_SCHEME" ] ; then
  envman add --key PROJECT_SCHEME --value "$API_PROJECT_SCHEME"
fi

このスクリプトは、 API_PROJECT_SCHEME Env Varが定義されており、定義されている場合、その値はに割り当てられます。 PROJECT_SCHEME 環境変数、の元の値を上書きします PROJECT_SCHEME。

アプリの YAML 構成ファイルで直接 Env Vars を設定できます。アプリの構成ファイルでは、アプリ レベルとワークフロー レベルの両方の Env Vars を設定できます。

この例では、アプリレベルの Env Var を持つ構成があります。 TEST_KEY:

app:  
  envs:  
  - opts:      
      is_expand: false    
    TEST_KEY: test value

この例では、 deploy-alpha ワークフローは、と呼ばれる環境変数を定義します ENV_TYPEを実行し、その環境変数を使用できる別のワークフローを実行します。

workflows:

  deploy-alpha:
    envs:
    - ENV_TYPE: alpha
    after_run:
    - _deploy

  _deploy:
    steps:
    - script:
        inputs:
        - content: |
            #!/bin/bash
            echo "ENV_TYPE: $ENV_TYPE"

あなたが実行する場合 deploy-alpha ワークフロー、それは設定します ENV_TYPE Env Var to alpha、それからそれは実行されます deploy そのEnv変数を使用できるワークフロー。この例では、単にその値を出力します（印刷されるテキストは次のようになります： ENV_TYPE: alpha）。