メインコンテンツまでスキップ

利用可能なenvironment variables

Environment Variables（Env Vars）は、キーと値で構成されます。任意の属性を含めることもできます。アプリ、Workflows、またはStepsのレベルで定義できます。

独自の Env Vars を設定できますが、Bitrise CLIまたは bitrise.io によって自動的に公開される Env Vars も用意されています。

さらに、多くのBitrise Stepsが出力変数をエクスポートします。これらの変数は、ビルド中の後続のStepsで使用できます。各StepのStep設定で確認できます。

  • Workflow Editorでは、Stepの Output properties セクションで確認できます。
  • Stepのstep.ymlでは、outputsの下に表示されます。

Release Managementは、Bitriseビルドにも多数の Env Vars を渡します。Release Management Env Varsを参照してください。

Environment Variablesには、利用可能になる順序が決まっています。これは、ビルドの進行に伴って Env Vars が利用可能になる順序です。Environment Variablesの提供順序。

Env Vars として公開されるStepの出力

Stepsは、Stepの出力を Env Vars として公開することもできます。たとえば、バイナリをビルドするStepは、そのバイナリを Env Var として他のStepsに公開できます。ほぼすべてのBitrise Stepがこの方法で出力を公開できるため、すべてを一覧にすることはしませんが、git クローン処理に関連するEnvironment Variablesはすべて次のページで確認できます。Git clone Env Vars。

Bitrise CLIが公開する Env VarsClick to copy link​

Env Var説明
$BITRISE_TRIGGERED_WORKFLOW_IDトリガーされたWorkflowの ID です。この Env Var は、Workflowが手動と自動のどちらでトリガーされたかにかかわらず公開されます。
$BITRISE_TRIGGERED_WORKFLOW_TITLEトリガーされたWorkflowのタイトルです。この Env Var は、Workflowが手動と自動のどちらでトリガーされたかにかかわらず公開されます。
$BITRISE_BUILD_STATUSビルドの現在のステータスです。指定できる値は次のとおりです。 - 0: 成功。 - 1: 失敗。 現在のステータスが成功の場合、ビルド内のそれ以前のStepsがいずれも失敗していないことを意味します。
$BITRISE_SOURCE_DIRベースとなる作業ディレクトリのパスです。デフォルトでは、別の値を指定しない限り、Bitriseを実行するディレクトリになります。ビルド中に上書きでき、その場合はビルド内の後続のStepsの作業ディレクトリが変更されます。
$BITRISE_DEPLOY_DIRアーティファクトとデプロイ用ファイルを保存するディレクトリのパスです。デフォルトではBitrise CLIが作成する一時ディレクトリで、Bitrise CLIを開始する前に上書きできます。Deploy to Bitrise.io - Build Artifacts, Test Reports, and Pipeline intermediate files Stepは、このディレクトリ内でビルドのアーティファクト(アプリの IPA や APK など)、テスト結果、その他のファイルを探します。
$BITRISE_TEST_DEPLOY_DIRBitrise CLIが作成するすべてのテスト結果のルートディレクトリです。このディレクトリに置かれたテスト結果は、他のすべてのテスト結果とともに表示できます。テスト結果のデプロイ。
$BITRISE_TEST_RESULT_DIR各Stepは、この変数に固有の値を持ちます。$BITRISE_TEST_DEPLOY_DIRの下に、各Stepがテスト結果を保存するための一意のサブディレクトリを提供します。
$BITRISE_FAILED_STEP_TITLEビルド内で最初に失敗したStepのタイトルです。つまり、ビルドのステータスを Failed に設定したStepです。
$BITRISE_FAILED_STEP_ERROR_MESSAGEビルド内で最初に失敗したStepのエラーメッセージです。
$CIBitrise CLIが Continuous Integration モードで実行されているかどうかを示します。指定できる値は次のとおりです。 - true - false
$PRBitrise CLIがPR(Pull Request)モードで実行されているかどうかを示します。Pull Request モードで実行すると、Bitriseは Pull Request がすでにマージされた状態のコードをビルドします。指定できる値は次のとおりです。 - true - false

bitrise.io が公開する Env VarsClick to copy link​

Env Var説明
$BITRISE_BUILD_NUMBERbitrise.io 上のビルドのビルド番号です。
$BITRISE_APP_TITLEbitrise.io 上のプロジェクトのタイトルです。プロジェクトの Project settings ページでいつでも変更できます。
$BITRISE_APP_URLbitrise.io 上のプロジェクトのURLです。Git リポジトリのURLとは異なります。プロジェクトのURLは次の形式です。 app.bitrise.io/app/APP-SLUG 例: https://app.bitrise.io/app/31e481ce08e0xfd9.
$BITRISE_APP_SLUGbitrise.io 上でプロジェクトを一意に識別するスラッグです。プロジェクトのURLにも含まれます。
$BITRISE_BUILD_URLbitrise.io 上のビルドのURLです。
$BITRISE_BUILD_SLUGbitrise.io 上でビルドを一意に識別するスラッグです。ビルドのURLにも含まれます。 たとえば、次のビルドのURLを見てみましょう。https://app.bitrise.io/app/31e481ce08e0xfd9/build/d75abbebxfc9ca4e. この例では、ビルドのスラッグは d75abbebxfc9ca4e です。
$BITRISE_BUILD_TRIGGER_TIMESTAMPビルドがトリガーされた日時です。
$GIT_REPOSITORY_URLプロジェクトをホストする Git リポジトリのURLです。Project settings ページの Repository セクションで変更できます。SSHまたはHTTPSの形式を使用できます。
$BITRISE_GIT_BRANCHBitriseがビルドする git ブランチです。例: main。
$BITRISEIO_GIT_BRANCH_DESTPull Request によってトリガーされたビルドでのみ使用されます。ビルドをトリガーした Pull Request の宛先/ターゲットブランチです。 たとえば、ある Pull Request があるブランチの内容をブランチ main にマージしようとしているとします。この場合、この Env Var の値は main です。GitHubスタック内の Pull Request では、値は Pull Request が直接ターゲットとするブランチではなく、スタックのベースブランチになります。
$BITRISE_GIT_TAGビルドがGit Tagによってトリガーされた場合、この Env Var には使用されたタグが格納されます。
$BITRISE_GIT_COMMIT該当する場合、ビルドをトリガーした Git コミットのコミットハッシュです。
$BITRISE_GIT_MESSAGEコミットメッセージ、Pull Request のタイトル、またはビルドを手動でトリガーした場合に指定したメッセージです。
$BITRISEIO_GIT_REPOSITORY_OWNERプロジェクトの Git リポジトリのオーナーです。
$BITRISEIO_GIT_REPOSITORY_SLUGプロジェクトの Git リポジトリのスラッグです。
$BITRISE_PULL_REQUESTビルドをトリガーした Pull Request の ID です。
$BITRISEIO_PULL_REQUEST_REPOSITORY_URLビルドをトリガーした Pull Request の送信元リポジトリのURLです。
$BITRISEIO_PULL_REQUEST_MERGE_BRANCHマージ前のブランチです。Git ホスティングプロバイダーが、Pull Request のマージ前の状態を専用のマージブランチで提供している場合に使用されます。
$BITRISEIO_PULL_REQUEST_HEAD_BRANCHPull Request のヘッドブランチです。Git ホスティングプロバイダーのシステムがこれをサポートし提供している場合に使用されます。この特別な git ref は、Pull Request のソースを指します。
$GITHUB_PR_IS_DRAFTGitHubでホストされているプロジェクトのみ: ビルドがドラフトの Pull Requestによってトリガーされた場合、true に設定されます。
$BITRISE_PROVISION_URLbitrise.io にアップロードされたAppleプロビジョニングプロファイルのURLです。プロジェクトに複数のプロビジョニングプロファイルがアップロードされている場合は、パイプ文字(`
$BITRISE_CERTIFICATE_URLbitrise.io にアップロードされたApple証明書のURLです。プロジェクトに複数の証明書がアップロードされている場合は、パイプ文字(`
$BITRISE_CERTIFICATE_PASSPHRASEプロジェクトの Code signing タブでアップロード済みのApple証明書に設定したパスフレーズです。パスフレーズ付きの証明書が複数ある場合は、パイプ文字(`
$BITRISE_IOビルドが bitrise.io 環境で実行されていることを示します。Bitriseがビルドを開始するときに、値が true に設定されます。
$BITRISE_TRIGGER_BYビルドをトリガーしたエンティティを識別します。値は次のいずれかです。 - Git プロバイダーによってビルドがトリガーされた場合は、Git ユーザーの名前。 - Bitriseの Web UIからビルドを手動でトリガーした場合は、Bitriseユーザーの名前。 - それ以外の方法でビルドがトリガーされた場合(たとえばスケジュールされたビルドやAPIによってトリガーされたビルド)は、triggered_by ビルドパラメーターで指定された値。
$BITRISE_TRIGGER_METHODビルドがトリガーされた方法です。 - schedule: スケジューラーによってビルドがトリガーされた場合。 - webhook: Git プロバイダーの Webhook によってビルドが自動的にトリガーされた場合。 - manual: APIとBitrise CLIを含む、その他のトリガーによってビルドがトリガーされた場合。
$BITRISE_GIT_PULL_REQUEST_COMMENTPull Request(GitLabの場合はマージリクエスト)のコメントメッセージと、対応する ID です。 PRコメントによってビルドがトリガーされた場合にのみ使用できます。ビルドトリガーに pr_comment の値が必要です。
$BITRISE_GIT_PULL_REQUEST_COMMENT_IDPull Request のコメント ID です。PRコメントによってビルドがトリガーされた場合にのみ使用できます。
$BITRISE_GIT_PULL_REQUEST_LABELSPull Request に追加された新しいラベルと、既存のラベルの複数行リストです。Pull Request にラベルを追加したことでビルドがトリガーされた場合、または既存のラベルを持つPRイベントによってトリガーされた場合にのみ使用できます。 GitHubとGitLabでのみサポートされます。
$BITRISE_GIT_CHANGED_FILESコードのプッシュまたは Pull Request で変更されたファイルパスの一覧です。1 イベントあたり最大 3000 ファイルが含まれます。次の場合に使用できます。 - プッシュイベントによってビルドがトリガーされた場合。GitHubとGitLabでのみサポートされます。 - PRイベントによってビルドがトリガーされ、トリガーに changed_files または commit_message 条件がある場合。主要な 3 つの Git プロバイダーすべてでサポートされます。 注: この env var は、ビルドによっては非常に大きくなることがあります。この env var を解析するカスタムスクリプトを作成する場合は、後述の env var のサイズ制限のセクションを参照してください。
$BITRISE_GIT_COMMIT_MESSAGESコードのプッシュまたは Pull Request のコミットメッセージです。最初の 2048 件までのコミットが含まれ、各メッセージは最大 1000 文字です。次の場合に使用できます。 - プッシュイベントによってビルドがトリガーされた場合。GitHubとGitLabでのみサポートされます。 - PRイベントによってビルドがトリガーされ、トリガーに commit_message 条件がある場合。主要な 3 つの Git プロバイダーすべてでサポートされます。 注: この env var は、ビルドによっては非常に大きくなることがあります。この env var を解析するカスタムスクリプトを作成する場合は、後述の env var のサイズ制限のセクションを参照してください。
$BITRISE_WORKSPACE_IDプロジェクトを所有するworkspaceの workspace スラッグです。
GitHubスタックされた Pull Request と diff

GitHubスタック内の Pull Request では、$BITRISEIO_GIT_BRANCH_DEST にスタックのベースブランチが格納されます。これを基準に diff を取るスクリプト(たとえば git diff origin/$BITRISEIO_GIT_BRANCH_DEST...HEAD)は、この Pull Request だけの変更ではなく、この Pull Request までを含むスタック全体の変更を返します。

Env Var のサイズ制限

上記のenvironment variablesの一部は、ビルドによっては非常に大きくなることがあります(たとえば、git コミットのメッセージが非常に長い場合や、Pull Request が数千ファイルを変更する場合)。すべての env vars の合計サイズがOSの制限に達する場合、Bitriseは一部の env vars を実行時環境から削除し、完全な値をディスク上のファイルに書き込みます。

大きくなる可能性のある env vars に依存するカスタムスクリプトがある場合は、代わりにこの env ファイルから値を読み取ってください。この env var は、macOS とLinux スタックのどちらでも $BITRISEIO_ENVFILE_PATH にあります。形式は次のとおりです。

envs:
  # Every env var from the build trigger and git event.
  BITRISE_GIT_CHANGED_FILES: ...
  BITRISE_GIT_COMMIT_MESSAGES: ...
  CI: true
  PR: true
  [...]

# List of env var KEYS that had to be erased. You should read the original value from the map above, this is just for debugging.
erased_envs:
- BITRISE_GIT_CHANGED_FILES

Pipeline Env Vars bitrise.io が公開するClick to copy link​

Env Var説明
$BITRISEIO_PIPELINE_ID実行中のPipelineビルドの ID です。この Env Var は、Pipelineが手動と自動のどちらでトリガーされたかにかかわらず公開されます。
$BITRISEIO_PIPELINE_TITLE実行中のPipelineビルドの名前です。この Env Var は、Pipelineが手動と自動のどちらでトリガーされたかにかかわらず公開されます。
$BITRISEIO_FINISHED_STAGESビルド内で完了済みの Stages とWorkflowsのステータスです。この Env Var の値は将来変更される可能性があるためご注意ください。
$BITRISEIO_PIPELINE_BUILD_STATUSPipelineビルドの現在のステータスです。この Env Var の値は succeeded、succeeded_with_abort、failed、aborted のいずれかです。Pipelineの実行中は、この Env Var のステータスは完了済みの Stages に基づきます。
$BITRISEIO_PIPELINE_BUILD_URLPipelineビルドのURLです。

Release Management Env VarsClick to copy link​

Env Var説明
$RM_RELEASE_IDbitrise.io 上のリリースの一意の識別子です。リリースのURLにも含まれます。
$RM_RELEASE_VERSIONRelease Managementでのリリース名(Google Playリリースの場合)またはバージョン(App Store リリースの場合)です。
$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_CANDIDATE_BUILD_SLUGリリースのリリース候補として選択されたビルドのビルドスラッグです。
$RM_CONNECTED_APP_IDbitrise.io 上の connected app の一意の識別子です。
$RM_PROJECT_IDbitrise.io 上のプロジェクトの一意の識別子です。プロジェクトのURLにも含まれます。
$RM_WORKSPACE_IDbitrise.io 上のworkspaceの一意の識別子です。
$RM_EVENT_IDBitrise CI workflows を開始するトリガーを識別します。イベントとその ID の一覧は、Configuring release automation ページを参照してください。

Git clone Env VarsClick to copy link​

Env Var説明
$GIT_CLONE_COMMIT_HASHビルドが使用するコミット(クローンしたコミット)のハッシュです。
$GIT_CLONE_COMMIT_MESSAGE_SUBJECTクローンしたコミットのコミットメッセージの件名です。
$GIT_CLONE_COMMIT_MESSAGE_BODYクローンしたコミットのコミットメッセージの本文(内容)です。
$GIT_CLONE_COMMIT_COUNTクローンしたコミットのコミット数です。この Env Var は clone_depth Step入力の影響を受けます。詳細は、Git Clone Stepの説明を参照してください。
$GIT_CLONE_COMMIT_AUTHOR_NAMEクローンしたコミットの作成者の名前です。
$GIT_CLONE_COMMIT_AUTHOR_EMAILクローンしたコミットの作成者のメールアドレスです。
$GIT_CLONE_COMMIT_COMMITTER_NAMEクローンしたコミットのコミッターの名前です。
$GIT_CLONE_COMMIT_COMMITTER_EMAILクローンしたコミットのコミッターのメールアドレスです。

関連情報