Custom strings settings
Customize strings used by Runway when creating artifacts throughout the release's lifecycle
Last updated
Customize strings used by Runway when creating artifacts throughout the release's lifecycle
Last updated
As part of its core functionality, Runway is capable of creating a number of artifacts on your behalf, like pull requests during automatic bump version or promote code actions, git tags during automatic tagging at the end of the release cycle, and more. These artifacts are populated with default strings, but you can customize the content of any of these strings to suit your team’s needs.
For any given string, there are a number of tokens available. In the final artifact, these tokens will be replaced with relevant values for the release or app in question.
A complete list of strings that can be customized (including default strings and available tokens for each) can be found in the table below.
| String type | Default value | Available tokens |
|---|---|---|
* The {workItems} token pulls in a markdown-formatted list of commits in the release diff, with any associated project management tickets also linked. You can filter these items using a modifier trailing the token. For example:
{workItems}[[bug]] – will only include items containing the string [bug] in their commit message
{workItems}[bug,fix] – will only include items containing the string bug or fix in their commit message
{workItems}[!bug] – will only include items that do not contain the string bug in their commit message
Bump version PR title
Bump version to {version}
{version}
{versionConcise}
{releaseName}
{releasePilot}
{releaseBranchName}
{workingBranchName}
Bump version PR body
Runway bumped your version to {version}
{version}
{versionConcise}
{releaseName}
{releasePilot}
{releaseBranchName}
{workingBranchName}
Bump version commit message
Bumping version to {version}
{version}
{versionConcise}
{releaseName}
{releasePilot}
{releaseBranchName}
{workingBranchName}
Promote code PR title
{workingBranchName} ->{releaseBranchName} for release {version}
{version}
{versionConcise}
{releaseName}
{releasePilot}
{releaseBranchName}
{workingBranchName}
Promote code PR body
Runway promoted {workingBranchName} to {releaseBranchName} for release {version}
{version}
{versionConcise}
{releaseName}
{releasePilot}
{releaseBranchName}
{workingBranchName}
Backmerge PR title
Backmerge {releaseBranchName} to {workingBranchName}
{version}
{versionConcise}
{releaseName}
{appStoreBuildNumber}
{ciBuildNumber}
{releasePilot}
{releaseBranchName}
{workingBranchName}
Backmerge PR body
Runway backmerged release branch {releaseBranchName} to working branch {workingBranchName}
{version}
{versionConcise}
{releaseName}
{appStoreBuildNumber}
{ciBuildNumber}
{releasePilot}
{releaseBranchName}
{workingBranchName}
VCS Release title
Release {version}
{version}
{versionConcise}
{releaseName}
{appStoreBuildNumber}
{ciBuildNumber}
{releasePilot}
{releaseBranchName}
{workingBranchName}
VCS release body
The default string for the VCS release body is dynamically generated from the list of commits and any associated tickets in the diff for the release.
{version}
{versionConcise}
{releaseName}
{appStoreBuildNumber}
{ciBuildNumber}
{releasePilot}
{releaseBranchName}
{workingBranchName}
{workItems}*
Git tag message
Release {version} tagged by Runway
{version}
{versionConcise}
{releaseName}
{appStoreBuildNumber}
{ciBuildNumber}
{releasePilot}
{releaseBranchName}
{workingBranchName}
Release summary
The release summary generated by Runway at the end of each release
{version}
{versionConcise}
{releaseName}
{appStoreBuildNumber}
{ciBuildNumber}
{releasePilot}
{releaseBranchName}
{workingBranchName}
{workItems}
{appName}
{appPlatform}
{workItemsCount
{issuesCount}
{commitsCount
{contributorsCount
{linesOfCodeCount
{releaseNotes
{releaseDuration}
{releasedAt
{releaseWorkItemsLink}
{releaseAppStoreLink
{releaseVCSReleaseLink}
Cherry-pick PR title
The title of the cherry-pick PR created by Runway
{version}
{versionConcise}
{releaseName
{releasePilot
{releaseBranchName
{workingBranchName}
{prTitleOrCommitMessage}
Cherry-pick PR bod
The contents of the cherry-pick PR body for the PR created by Runway
{version}
{versionConcise}
{releaseName
{releasePilot
{releaseBranchName
{workingBranchName}
{prTitleOrCommitMessage}
{prBodyOrCommitHash}
Cherry-pick commit message
The commit message for commits cherry-picked by Runway
{commitMessage}