Skip to main content

利用可能な環境変数

概要

環境変数（Env Vars）は、キーと値、およびオプションの属性で構成されます。これらは、アプリ、ワークフロー、またはステップのレベルで定義できます。

環境変数 （Env Vars）はキーと値で構成されます。オプションの属性を含めることもできます。それらはのレベルで定義することができます アプリ、 ワークフロー また 手順。

独自のEnvVarを設定できますが、BitriseCLIまたはBitriseCLIのいずれかによって自動的に公開されるEnvVarの選択があります。 bitrise.io。

さらに、多くの Bitrise ステップは出力変数をエクスポートします。これらの変数は、ビルド中に後続のステップで使用できます。各ステップのステップ設定で見つけることができます。

  • ワークフローエディタでは、 出力プロパティ ステップのセクション。

  • では step.yml ステップの下にある outputs。

リリース管理 また、いくつかの Env Vars を Bitrise ビルドに渡します。 表4「リリース管理からビルドに渡される環境変数」。

環境変数には、利用可能な順序が設定されています。ビルドの進行中に利用可能になる順序は次のとおりです。 環境変数の可用性の順序。

環境変数として公開されたステップ出力

ステップは、ステップ出力を環境変数として公開することもできます。たとえば、バイナリを構築するステップは、そのバイナリを環境変数として他のステップに公開できます。基本的にどの Bitrise ステップでもこの方法で出力を公開できるため、すべてをリストすることはしませんが、git クローン作成プロセスに関連するすべての環境変数を見つけることができます。 表5「Git クローン リポジトリ ステップによって公開される環境変数」.

表1 BitriseCLIによって公開された環境変数

環境変数キー

説明

$BITRISE_TRIGGERED_WORKFLOW_ID

だったワークフローのID 引き金になった。このEnvVarは、ワークフローが手動でトリガーされたか自動でトリガーされたかに関係なく公開されます。

$BITRISE_TRIGGERED_WORKFLOW_TITLE

トリガーされたワークフローのタイトル。この環境変数は、ワークフローが手動でトリガーされたか自動でトリガーされたかに関係なく公開されます。

$BITRISE_BUILD_STATUS

ビルドの現在のステータス。使用可能なオプションは次のとおりです。

  • 0：成功しました。

  • 1：失敗しました。

成功した現在のステータスは、ビルドの前のステップのいずれも失敗しなかったことを意味します。

$BITRISE_SOURCE_DIR

基本作業ディレクトリへのパス。デフォルトでは、別の値を指定しない限り、これはBitriseが実行されるディレクトリです。これはビルド中に上書きされる可能性があり、ビルドの後続のステップの作業ディレクトリが変更されます。

$BITRISE_DEPLOY_DIR

デプロイメント用のアーティファクトとファイルを格納するディレクトリへのパス。これは、デフォルトでBitrise CLIによって作成される一時ディレクトリであり、BitriseCLIを開始する前に上書きできます。 NS Bitrise.ioにデプロイします ステップは、ビルドアーティファクト（アプリのIPAやAPKなど）、テスト結果、およびこのディレクトリ内の他のファイルを探します。

$BITRISE_TEST_RESULT_DIR

Bitrise CLIによって作成されたすべてのテスト結果のルートディレクトリ。このディレクトリに配置されたテスト結果は、 テストレポートアドオン。

$CI

BitriseCLIが継続的インテグレーションモードで実行されているかどうかを示します。可能な値は次のとおりです。

  • true

  • false

$PR

Bitrise CLIがPR（プルリクエスト）モードで実行されているかどうかを示します。プルリクエストモードで実行するということは、Bitriseがプルリクエストがすでにマージされているかのような状態でコードをビルドすることを意味します。可能な値は次のとおりです。

  • true

  • false

表2 bitrise.ioによって公開された環境変数

環境変数キー

説明

$BITRISE_BUILD_NUMBER

ビルドのビルド番号 bitrise.io。

$BITRISE_APP_TITLE

上のアプリのタイトル bitrise.io。あなたはいつでもそれを変更することができます 設定 アプリのタブ。

$BITRISE_APP_URL

上のURLまたはアプリ bitrise.io。これはgitリポジトリのURLと同じではありません！アプリのURLの形式は次のとおりです。

app.bitrise.io/APP-SLUG/

例：https：//app.bitrise.io/app/31e481ce08e0xfd9。

$BITRISE_APP_SLUG

上のアプリを一意に識別するスラッグ bitrise.io。これもアプリのURLの一部です。

$BITRISE_BUILD_URL

ビルドのURL bitrise.io。

$BITRISE_BUILD_SLUG

ビルドを一意に識別するスラッグ bitrise.io。これもビルドURLの一部です。

たとえば、次のビルドURLを見てみましょう：https：//app.bitrise.io/build/d75abbebxfc9ca4e。ビルドスラッグは d65abbebxfc9ca4e この例では。

$BITRISE_BUILD_TRIGGER_TIMESTAMP

ビルドがトリガーされた日時。

$GIT_REPOSITORY_URL

アプリをホストするGitリポジトリのURL。これはで変更できます 設定 アプリのタブ。 SSH形式またはHTTPS形式のいずれかです。

$BITRISE_GIT_BRANCH

Bitriseによって構築されたgitブランチ。例えば、 main。

$BITRISEIO_GIT_BRANCH_DEST

プルリクエストによってトリガーされたビルドでのみ使用されます：ビルドをトリガーしたプルリクエストの宛先/ターゲットブランチ。

たとえば、プルリクエストはブランチのコンテンツをブランチにマージしたいと考えています main。この場合、このEnvVarの値は次のようになります。 main。

$BITRISE_GIT_TAG

ビルドがGitタグによってトリガーされた場合、このEnvVarは使用されたタグを保存します。

$BITRISE_GIT_COMMIT

該当する場合、ビルドをトリガーしたGitコミットのコミットハッシュ。

$BITRISE_GIT_MESSAGE

コミットメッセージ、プルリクエストのタイトル、またはビルドを手動でトリガーした場合に指定したメッセージ。

$BITRISEIO_GIT_REPOSITORY_OWNER

アプリのGitリポジトリの所有者。

$BITRISEIO_GIT_REPOSITORY_SLUG

アプリのGitリポジトリのスラッグ。

$BITRISE_PULL_REQUEST

ビルドをトリガーしたプルリクエストのID。

$BITRISEIO_PULL_REQUEST_REPOSITORY_URL

ビルドをトリガーしたプルリクエストが送信されたリポジトリのURL。

$BITRISEIO_PULL_REQUEST_MERGE_BRANCH

事前マージブランチ-Gitホスティングプロバイダーが特別なマージブランチでプルリクエストの事前マージ状態をサポートおよび提供する場合。

$BITRISEIO_PULL_REQUEST_HEAD_BRANCH

Gitホスティングプロバイダーシステムがこれをサポートおよび提供している場合は、プルリクエストヘッドブランチ。この特別なgitrefは、プルリクエストのソースを指している必要があります。

$GITHUB_PR_IS_DRAFT

GitHub でホストされているアプリの場合のみ: に設定されます。 true ビルドがトリガーされた場合 ドラフトプルリクエスト。

$BITRISE_PROVISION_URL

にアップロードされたAppleプロビジョニングプロファイルのURL bitrise.io。アプリにアップロードされたプロビジョニングプロファイルが複数ある場合は、パイプ文字（|）リスト内のURLを区切ります。

これは、iOSアプリとiOSバージョンのクロスプラットフォームアプリにのみ関係します。

$BITRISE_CERTIFICATE_URL

にアップロードされたApple証明書のURL bitrise.io。アプリに複数の証明書がアップロードされている場合は、パイプ文字（|）リスト内のURLを区切ります。

これは、iOSアプリとiOSバージョンのクロスプラットフォームアプリにのみ関係します。

$BITRISE_CERTIFICATE_PASSPHRASE

アプリのアップロードされた Apple 証明書に設定したパスフレーズ コード署名とファイル タブ。パスフレーズを持つ証明書が複数ある場合は、パイプ文字 (|) は、リスト内のフレーズを区切ります。

これは、iOSアプリとiOSバージョンのクロスプラットフォームアプリにのみ関係します。

$BITRISE_IO

ビルドがbitrise.io環境で実行されていることを示します。値はに設定されます true ビルドを開始するときにBitriseによって。

表3 bitrise.io によって公開されたパイプライン環境変数

環境変数キー

説明

$BITRISEIO_PIPELINE_ID

実行中の Pipeline ビルドの ID。この環境変数は、パイプラインが手動でトリガーされたか自動でトリガーされたかに関係なく公開されます。

$BITRISEIO_PIPELINE_TITLE

実行中の Pipeline ビルドの名前。この環境変数は、パイプラインが手動でトリガーされたか自動でトリガーされたかに関係なく公開されます。

$BITRISEIO_FINISHED_STAGES

ビルドで以前に完了したステージとワークフローのステータス。この環境変数の値は将来変更される可能性があることに注意してください!

$BITRISEIO_PIPELINE_BUILD_STATUS

Pipeline ビルドの現在のステータス。この環境変数の値は次のとおりです。 succeeded、 succeeded_with_abort、 failed、 と aborted.パイプラインの実行中、環境変数のステータスは、以前に完了したステージに基づいています。

$BITRISEIO_PIPELINE_BUILD_URL

Pipeline ビルドの URL。

表4 リリース管理からビルドに渡される環境変数

環境変数キー

説明

RM_RELEASE_CANDIDATE_VERSION

リリース候補ビルドによって生成されたバイナリ (APK/AAB または IPA ファイル) のバージョン。

RM_RELEASE_CANDIDATE_DOWNLOAD_URL

リリース候補ビルドによって生成されたバイナリ (APK/AAB または IPA ファイル) のダウンロード URL。

RM_RELEASE_CANDIDATE_SLUG

リリース候補ビルドによって生成されたバイナリ (APK/AAB または IPA ファイル) の一意の識別子。

RM_RELEASE_VERSION

リリース管理におけるリリース名 (Google Play リリースの場合) またはバージョン (App Store リリースの場合)。

RM_RELEASE_CANDIDATE_BUILD_SLUG

リリースのリリース候補として選択されたビルドのビルド スラッグ。

表5 Git クローン リポジトリ ステップによって公開される環境変数

環境変数キー

説明

$GIT_CLONE_COMMIT_HASH

ビルドが使用するコミットのハッシュ (複製されたコミット)。

$GIT_CLONE_COMMIT_MESSAGE_SUBJECT

複製されたコミットのコミット メッセージの件名。

$GIT_CLONE_COMMIT_MESSAGE_BODY

複製されたコミットのコミット メッセージの本文 (コンテンツ)。

$GIT_CLONE_COMMIT_COUNT

複製されたコミットのコミット数。この環境変数は、 clone_depth ステップ入力。詳細については、 Git クローンの手順の説明.

$GIT_CLONE_COMMIT_AUTHOR_NAME

複製されたコミットの作成者の名前。

$GIT_CLONE_COMMIT_AUTHOR_EMAIL

複製されたコミットの作成者の電子メール。

$GIT_CLONE_COMMIT_COMMITER_NAME

複製されたコミットのコミッターの名前。

$GIT_CLONE_COMMIT_COMMITER_EMAIL

複製されたコミットのコミッターの電子メール。

このセクションの内容:
アプリワークフロー手順引き金になった