使用可能な環境変数
Find all available environment variables for Unity Build Automation scripts and builds.
読み終わるまでの所要時間 3 分最終更新 1日前
以下のテーブルは、Unity Build Automation の環境変数のリストです。
システム
システム環境変数は、システムの動作とインストールされたリソースの場所をコントロールします。すべての変数が設定され、ビルド前とビルド後の両方のスクリプトで使用できます。変数 | 説明 |
|---|---|
| ANDROID_HOME | Android Lib へのローカルパス |
| ANDROID_NDK_ROOT | Android NDK ルートディレクトリへのローカルパス |
| BUILDER_OS | ビルドが実行されている OS の種類。MAC または Windows |
| CCD_BINARY_PATH | Cloud Content Delivery バイナリ実行ファイルへのローカルパス |
| HOMEDRIVE | ホームドライブの場所 |
| HOMEPATH | ホームディレクトリへの相対パス |
| OUTPUT_DIRECTORY | ビルドプロセスの出力を含むディレクトリへのパス |
| PLASTIC_CM_PATH | Plastic CLI へのパス。Windows 環境を使用している場合は、Cygwin パスに変換して、パスが有効かどうかを確認できます。 |
| PLASTIC_CM_CONFIG_DIRECTORY | Plastic CLI 設定ファイルへのパス |
| PLATFORM_HOST | ビルドサービス API のホスト。例/ usersvc-live.cloud.unity3d.com |
| PROJECT_DIRECTORY | ビルドするプロジェクトのルートディレクトリへのパス |
| SCM_MAX_RETRIES | ソースコードのチェックアウト時に試行される再試行の最大回数 |
| UNITY_EXE | Unity エンジン実行ファイルの場所 |
| UPM_REGISTRY | Unity Package Manager の URL |
| UPM_SERVER_ENABLED | true (デフォルト) に設定すると、エージェントで UPM Server を開始します。 |
| UPM_SERVER_EXE | Unity Package Manager Server 実行ファイルへのパス |
| UPM_SERVER_PORT | UPM Server が実行されるポート |
| USERPROFILE | OS 上のユーザーホームの場所 |
| WEBGL_STREAMING_ENABLED | true (デフォルト) に設定すると、WebGL プロジェクトの StreamingAssets へのパスは、アーカイブへのパスリストから除外されます。 |
| WORKSPACE | 特定のビルドターゲットのすべてのフォルダーが作成されるエージェントのローカルパス。例えば /opt/workspace/workspace |
ビルド
ビルド環境変数は、ビルドの実行に関連し、コントロールします。一般的なビルド変数のリストを以下に示します。ビルドプロセスの一部の特定の実行に関連するビルド変数は、そのセクションで分類されます。Unity ビルドの実行前に設定できない変数もあります。使用する前に値を確認することを推奨します。変数 | 説明 |
|---|---|
| BACKTRACE_ENABLED | "true" (デフォルト) に設定すると、エラーバックトレースをログに記録できます。 |
| BUILD_PLATFORM | ビルドされるターゲットの種類 |
| BUILD_TARGET | UCB ビルドターゲットの ID |
| BUILD_REVISION | ビルドされるソースコードの現在のリビジョン。 |
| BUILDCFG_FILE | ビルド設定ファイルへのローカルパス |
| BUILDCFG_TARGET | ビルドされるターゲットの名前 (または ID) |
| BUILDJOB_CACHE | ビルドが完了したときにキャッシュするファイルの種類。デフォルトは "ライブラリ" です。Admin UI からのみ "workspace" に設定できます。専用ビルダーの使用がローカルに設定されている場合 |
| CLEAN_BUILD | true に設定すると、キャッシュされたライブラリやワークスペースがプルされません。Git を使用する場合、 Git Clean を実行します。Perforce を使用する場合、 p4 forcesync を実行します。 |
| IS_BUILDER | ビルドエージェントで実行する場合は true に設定します。ローカルで実行している場合は False |
| LOG_VERBOSE | verbose オプションが Xcode プロジェクトに渡されたときに 1 に設定 |
| ORG_ID | UCB 組織の ID |
| PARENT_BUILD_GUID | このビルドの主要なアーティファクトがダウンロードされ、再署名されます。すでにビルドされたアーティファクトに再署名するときにのみ設定 |
| PREVIOUS_SUCCESSFUL_BUILD_REVISION | 正常に構築されたターゲットの最後のリビジョン |
| PROJECT_ID | UCB プロジェクトの ID |
| SCM_BRANCH | ビルドするブランチの名前 |
| SCM_REVISION | チェックアウトする特定のコミットハッシュ。ビルド設定で指定されたときのみ設定されます。 |
| SCM_HOST | ソース管理マネージャーのホスト URL |
| SCM_USER | SCM からコードをチェックアウトするためのユーザ名 |
| SKIP_UPLOAD_ARTIFACTS | 1 に設定すると、ビルドされたアーティファクトの UCB へのアップロードがスキップされます。 |
| UCB_BUILD_NUMBER | ビルドする特定のターゲットのビルド番号 |
| XCARCHIVE_PATH | Xcode アーカイブファイルのローカルパス ex/ '~/Library/Developer/Xcode/Archives/something.xcarchive |
Cloud Content Delivery
これらの変数は、ビルド設定に基づいて CCD_ENABLED が true に設定されている場合にのみ使用できます。変数 | 説明 |
|---|---|
| CCD_BUCKET_ID | コンテンツをアップロードするバケットの ID。ビルド設定によって定義されます。 |
| CCD_CREATE_RELEASE | "true" に設定すると、バケットの最新バージョンからリリースが作成されます。ビルド設定によって定義されます。 |
| CCD_ENABLED | "true" に設定すると、Cloud Content Delivery が使用されます。ビルド設定によって定義 |
| CCD_PRESERVE_BUCKET | true に設定すると、バケット内の既存のコンテンツは削除されません。ビルド設定によって定義されます。 |
| CCD_STRIP_REMOTE_PATH | "true" に設定すると、バケットが保持され、フォルダーレベルではなくルートに直接ファイルがアップロードされます。ビルド設定によって定義されます。 |
Fastlane
Fastlane 環境変数は Fastlane の動作をコントロール変数 | 説明 |
|---|---|
| FASTLANE_USER | Fastlane で使用するアプリストア Connect/Apple Developer ポータルのユーザー |
| FASTLANE_VERBOSE | "true" に設定すると、Fastlane コマンドを実行するときに詳細なログが有効になります。 |
| FL_NOTARIZE_ASC_PROVIDER | プロバイダーの WWDR チーム ID |
| FL_NOTARIZE_USE_NOTARYTOOL | Xcode 13 を使用し、これが true に設定されている場合、Fastlane での公証時に Xcode 公証ツールを使用します。 |
| FL_NOTARIZE_USERNAME | Fastlane で使用するアプリストア Connect/Apple Developer ポータルのユーザー |
Perforce
変数 | 説明 |
|---|---|
| P4_CLEANUPCLIENT | "true" に設定すると、Perforce リポジトリからコードをチェックアウトするときに deleteclient が実行されます。 |
| P4_SSL | "true" に設定すると、P4 はサーバーとの通信時に SSL を使用 |
| P4CLIENT | P4 SCM に対して操作を実行するときに使用する P4 クライアント |
| P4PORT | P4 SCM が実行されているポート |
| P4USER | P4 からコードをチェックアウトするユーザー名 |
UVCS (旧 Plastic SCM)
変数 | 説明 |
|---|---|
| PLASTIC_AUTH_TYPE | Plastic SCM での認証に使用されるメソッド |
| PLASTIC_ENCRYPTION_METHOD | Plastic SCM の暗号化の種類 |
Unity
変数 | 説明 |
|---|---|
| MONO_XMLSERIALIZER_THS | "No" に設定すると、Unity での Mono ビルドに THS XML シリアライザーを使用しません。 |
| UNITY_EXTRA_PARAMS | バッチモードで実行中に Unity エディターに渡される余分なパラメーター |
| UNITY_PLAYER_PATH | Unity Player へのローカルパス |
| UNITY_PLAYER_PATH_DATA | Windows または Mac ビルドの Unity Player データファイルへのローカルパス |
| UNITY_PLAYER_PATH_DEBUG_SYMBOLS | Android ビルドの Unity Player デバッグシンボルへのローカルパス |
| UNITY_PLAYER_PATH_DSYM | iOS ビルドの Unity Player デバッグシンボルへのローカルパス |
| UNITY_SHADER_COMPILER_RETRY_COUNT | "3" に設定します。Unity でのシェーダーのコンパイル時の再試行回数 |
| UNITY_VERSION | ビルドが実行される Unity のバージョン |
| UNITY_VERSION_DIFF | このビルドの Unity のバージョンが最後のビルドと異なる場合は true |
変数 | 説明 | パターン |
|---|---|---|
| UNITY_PLAYER_PATH_#{architecture} | 特定のアーキテクチャの Unity Player ファイルへのローカルパス。 | #{architecture} は、ビルドのターゲットアーキテクチャのプレースホルダー値を表します。例/出力アーキテクチャの 1 つが x86 の場合、環境変数は UNITY_PLAYER_PATH_X86 になります。 |
| UNITY_PLAYER_PATH_#{obb_file_type}_OBB | Unity Player OBB ファイルへのローカルパス | #{obb_file_type} は、さまざまな OBB ファイルのプレースホルダー値を表します。例/ファイル名が example.file.obb の場合、環境変数は UNITY_PLAYER_PATH_FILE_OBB |