StringFormatter

String Formatter Commands

The String Formatter is used to format strings in the build task. It supports commands that can be used to insert values into the string.

The following commands are available:

• {appleAppName}: The name of the App Store Connect app receiving the upload.
• {appleBuildId}: The App Store Connect Build resource ID returned after a TestFlight upload completes.
• {appleBuildNumber}: The CFBundleVersion (build number) of the most recent Apple upload.
• {appleBuildVersion}: The CFBundleShortVersionString (marketing version) of the most recent Apple upload.
• {appleBundleId}: The Bundle ID of the App Store Connect app receiving the upload.
• {buildArchitecture}: Which architecture the build will be (eg x64/x84)
• {buildName}: The name of the build as specified in a build config.
• {buildNumber}: A unique number of the build that is produced.
• {buildTarget}: Which platform targeting for the next build as defined in Build Settings.
• {buildTargetGroup}: The target group of the upcoming build as defined in Player Settings.
• {bundleVersion}: The version of your project for android/ios as specified in Player Settings.
• {cacheFolderPath}: The path where all files and builds are stored when build uploader is working.
• {companyName}: The name of your company as specified in Player Settings.
• {date}: The current local date in the format YYYY-MM-DD.
• {dateTime}: The current local date and time in the format YYYY-MM-DD HH-MM-SS.
• {destLocalPath}: The path which files will be copied to using the LocalPath destination.
• {dropboxAppName}: The name of the Dropbox App used to authenticate the upload.
• {dropboxFolderName}: The name of the Dropbox folder receiving the upload.
• {dropboxShareLink}: The public shared link created for the most recent Dropbox upload (if enabled).
• {epicgamesArtifactName}: The name of the artifact that is being uploaded to on Epic Games.
• {epicgamesOrganizationName}: The name of the organization that owns the product on Epic Games that will receive the files.
• {epicgamesProductName}: The name of the product that is being uploaded to on Epic Games.
• {gitBranch}: The git branch the project is currently on. eg: main. Reads HEAD when the repository is in a detached head state.
• {gitCommit}: The full hash of the commit the project is currently on.
• {gitCommitAuthor}: The name of the author of the commit the project is currently on.
• {gitCommitAuthorEmail}: The email address of the author of the commit the project is currently on.
• {gitCommitDate}: The date the commit the project is currently on was authored, in the format YYYY-MM-DD.
• {gitCommitMessage}: The whole message of the commit the project is currently on - both the subject and the body.
• {gitCommitMessageBody}: Everything after the first line of the message of the commit the project is currently on. Empty for a single line commit message, and can span multiple lines otherwise.
• {gitCommitMessageSubject}: The first line of the message of the commit the project is currently on. Always a single line.
• {gitCommitShort}: The shortened hash of the commit the project is currently on. eg: 3f2a91c
• {gitTag}: The most recent git tag reachable from the current commit. eg: v1.4.2. Empty when the repository has no tags.
• {googleChatSpaceName}: The name of the Google Chat space receiving the message.
• {googleDriveAppName}: The name of the Google App used to authenticate with Google Drive.
• {googleDriveFileID}: ID of the last file that was uploaded.
• {googleDriveFolderName}: The name of the Google Drive folder receiving the upload.
• {googleDriveWebViewURL}: A URL to the last file that was uploaded.
• {googlePlayEditId}: The Play Console edit id used by the most recent Google Play upload (already committed).
• {googlePlayPackageName}: The application package name (e.g. com.example.MyGame) of the most recent Google Play upload.
• {googlePlayTrack}: The release track (internal/alpha/beta/production) of the most recent Google Play upload.
• {googlePlayVersionCode}: The versionCode returned by Google Play after a successful binary upload.
• {itchioChannelName}: The channels/platforms that we are uploading to on Itchio.
• {itchioGameName}: The name of the game that is being uploaded to on Itchio.
• {itchioUserName}: The name of the user that owns the game that we want to upload the files to on Itchio.
• {machineName}: The name of the machine running the build.
• {persistentDataPath}: The path of the Persistent Data folder
• {productName}: The name of your product as specified in Player Settings.
• {projectPath}: The path of your Unity Project contains the Assets folder.
• {rootPath}: The path every other path can start from as specified in Preferences. eg: C:/SomeFolder/Builds/{version}
• {scriptingBackend}: The scripting backend for the next build as defined in Player Settings.
• {steamAppName}: The name of the app that is being uploaded to on Steamworks.
• {steamBranchName}: The name of the branch that we are uploading to on Steamworks.
• {steamDepotName}: The name of the depots that are being uploaded to on Steamworks.
• {taskDescription}: The description of the current task being executed.
• {taskFailedReasons}: Gets the reasons why the task failed to upload all destinations.
• {taskProfileName}: The name of the upload profile or task specified when creating the task.
• {taskStatus}: Get a small message describing the status of the Upload Task.
• {time}: The current local time in the format HH-MM-SS.
• {unityVersion}: The version of Unity you are using.
• {uploadNumber}: A unique number of the upload task that's getting sources and uploading them.
• {version}: The version of your project as specified in Player Settings.
• {versionMajor}: The version of your project as specified in Player Settings but only the major segment. eg: a1 from a1.2.3-beta1
• {versionMajorSem}: The major segment of the version of your project as specified in Player Settings but with only numbers. eg: 1 from a1.2.3-beta1
• {versionMinor}: The version of your project as specified in Player Settings but only the minor segment. eg: 2 from a1.2.3-beta1
• {versionMinorSem}: The minor segment of the version of your project as specified in Player Settings but with only numbers. eg: 2 from a1.2.3-beta1
• {versionPatch}: The version of your project as specified in Player Settings but only the patch segment. eg: 3 from a1.2.3-beta1
• {versionPatchSem}: The patch segment of the version of your project as specified in Player Settings but with only numbers. eg: 3 from a1.2.3-beta1
• {versionRevision}: The version of your project as specified in Player Settings but only the revision segment. eg: beta1 from a1.2.3-beta1
• {versionRevisionSem}: The revision segment of the version of your project as specified in Player Settings but with only numbers. eg: 1 from a1.2.3-beta1
• {versionSem}: The version of your project as specified in Player Settings but with only numbers. eg: 1.2.3 from a1.2.3-beta1