Types of automations
Some automations may be limited to certain plans. Please visit our pricing page to learn more.
Visit our Automations overview page for helpful information about how automations work in Runway, and how to set them up.
Categories
Release cycle
App store tasks
Beta testing
Translations
Release hygiene
General
Build Distro bucket automations
Create release-specific channel(s)
Runway will automatically create new Slack or Teams channel(s) for each release. To create a release-specific channel, one of the following must be true:
The Primary channel setting for your Slack or Teams integration contains a tokenized channel name (e.g.
release-{version})At least one notification has a tokenized channel name (e.g.
release-{version}) configured as a channel override
If multiple unique tokenized channel names are configured for different types of notifications, Runway will create channels matching each unique tokenized channel name if they don't exist already
Visit the Notification settings article for additional information on configuring release-specific channels.
If your app is configured with a Microsoft Teams integration, you must specify a Team that Runway should create release-specific channels in. This can be configured from the automation's settings modal.
Bump version in code
Runway detects where the app version is referenced in your code and bumps it according to your team's bump version strategy (configurable from settings for this automation):
Pre-kickoff, to current release version, on working branch: Runway will bump the version on your working branch to the current release version prior to kicking off your release.
⚠️ Requires the Kick off release on target date automation to be enabled.
Post-kickoff, to current release version, on release branch: Runway will bump the version on your release branch to the current release version once your current release has been kicked off.
Post-kickoff, to next version, on working branch: Runway will bump the version on your working branch to the next-up release version once your current release has been kicked off.
Post-submission, to next version, on working branch: Runway will bump the version on your working branch to the next-up release version as soon as your current release has been submitted for review.
Post-release, to next version, on working branch: Runway will bump the version on your working branch to the next-up release version as soon as your current version has been released to the app store.
By default, Runway will open a pull request against the target branch with the bump version commit. The copy for both the bump version commit message, the PR title and PR body are customizable from the Custom strings section in App Settings. If you have the Merge pull requests opened by Runway automation enabled, Runway will attempt to automatically merge the bump version PR as soon as all checks have passed.
Runway cannot automatically merge pull requests if all required checks on the PR have not passed. For example, if you require approvals to merge PRs into your target branch, approval requirements must be met before Runway can automatically merge.
Bypass pull requests option
If you'd prefer that Runway directly commit and push bump version commits to your target branch, you can enable the "Bypass pull requests" option on the automation. With this option enabled, Runway will create the bump version commit directly on your target branch and attempt to push up the new commit immediately.
If your repository has branch protection enabled for the target branch, and those branch protections include requiring pull requests to merge or restricting push access to your target branch, you'll need to update your branch protection rules to allow Runway to bypass requirements. Detailed instructions on how to set this up for each type of VCS integration are available here.
How Runway detects versions in code
By default, Runway will detect the app version from your codebase by inspecting a handful of platform-specific files where versions are commonly found, but you can always configure an override list of version files in from App Settings > General > Version files, which are not limited to any of the default file types and extensions.
Kick off release on target date
Static branching teams
Runway will promote code from your working branch to your release branch on the scheduled date.
By default, Runway will open a pull request against the release branch. You can customize the resulting PR title and body from the Custom strings section in App Settings. If you have the Merge pull requests opened by Runway automation enabled, Runway will attempt to automatically merge the code promotion PR as soon as all checks have passed.
Runway cannot automatically merge pull requests if all required checks on the PR have not passed. For example, if you require approvals to merge PRs into your release branch, approval requirements must be met before Runway can automatically merge.
Bypass pull requests option
Checking the "Bypass pull requests" option enables Runway to directly perform the code promotion by merging the working branch into the release branch without opening a pull request.
If your repository has the "Require a pull request before merging" branch protection setting enabled for the release branch, you'll need to add the Runway + GitHub app to the list of apps allowed to bypass the pull request requirement. Detailed instructions on how to enable this setting are available here.
This automation setting is only available for teams using GitHub as their VCS integration.
Release branching teams
Runway will create a release branch off of your working branch for the next release on the scheduled date.
This automation will always be inactive for hotfix releases in Runway.
Trigger workflow after release kickoff
Runway will trigger the configured Release Candidate build workflow after release is .
This automation is not supported for teams using TravisCI as their CI/CD integration.
Submit app for review
Runway will submit your selected build for review if all previous steps are ready (green).
Configuration
There are three submission strategy options you can choose from for this automation:
Submit for review on target date: Runway will submit for review on the specified target date if all previous steps are ready. If automated submission fails, you'll need to update to a future target submit date or release your update manually.
Submit for review as soon as all previous steps are ready, no earlier than target date: Runway will submit for review as soon as all previous steps are ready, no earlier than the specified target date. If automated submission fails, you'll need release your update manually.
Submit for review as soon as all previous steps are ready: Runway will submit for review as soon as all previous steps are ready. If automated submission fails, you'll need release your update manually.
You can pause automatic submission by clicking "Pause schedule" from the Schedule drawer in a release.
If automated submission fails, Runway will retry every 5 minutes up to a maximum of 5 times.
This automation will always be skipped (inactive) for hotfix releases in Runway.
Option to release beta track release to 100%
Android apps that have Google Beta configured as their beta testing integration have the option to have Runway automatically release the beta track release to 100% prior to submission on the Production track.
Release app on target date
iOS
Runway will release your app update (or start your phased release, if applicable) on the scheduled target release date if all previous steps are ready (green) and your app update has passed App Store review.
If automated release fails, Runway will attempt to release again every 5 minutes up to a maximum of 5 times. After that, you'll need to update to a future target release date, or release your update manually.
This automation will always be inactive for hotfix releases in Runway.
Release stable phased releases / staged rollouts to 100% of users
Runway will release your update to all users early if the release is healthy and has met the predefined conditions.
Health metrics for your app can be configured by visiting App settings > Health metrics.
This automation is not available for OTA apps.
Configuration
This automation can be configured with:
One or more health metrics. Only releases whose health metrics are all healthy will trigger an early release to all users.
At least one condition (such as minimum adoption threshold and minimum phased release day or staged rollout percentage). Only releases that have met the configured conditions will trigger an early release to all users.
You must configure at least one condition and one associated health metric for this automation.
Only releases that have met the configured conditions, and whose associated health metrics are healthy will trigger the automation to release to all users early.
When multiple AABs or APKs are associated with a given Android release version, Runway will look at health metrics for all builds — all must be within a ‘healthy’ threshold and must have met the configured conditions for the automation to trigger.
Halt unstable phased releases
Runway will halt your phased release / staged rollout if if any associated health metrics fall outside of their defined thresholds.
Health metrics for your app can be configured by visiting App settings > Health metrics.
This automation is not available for OTA apps.
Configuration
This automation can be configured with:
One or more health metrics. Any health metrics that fall outside of their defined thresholds will trigger the automation.
At least one condition (such as minimum adoption threshold and minimum phased release day or staged rollout percentage). Only releases that have met the configured conditions will trigger a halt to the release.
You must configure at least one condition and one associated health metric for this automation.
Only releases that have met the configured conditions, and whose associated health metrics are healthy will trigger the automation to release to all users early.
When multiple AABs or APKs are associated with a given Android release version, Runway will look at health metrics for all builds — any builds with "unhealthy" health metrics will trigger the halt automation as long as all required conditions have been met.
Backmerge changes from the release branch
Runway can automatically backmerge changes from the release branch to your working branch and any upcoming release branches. There are two backmerge strategy options to choose from.
Backmerge changes at the end of the release cycle
At the end of the release cycle, Runway will create a backmerge branch and open a pull request to merge the release branch back into the working branch and any upcoming release branches.
A backmerge branch will only be created if commits are found on the release branch that are not on the base branch.
If the app also has the merge pull requests opened by Runway automation enabled, Runway will attempt to automatically merge the backmerge branch if all required checks have passed.
Backmerge changes continuously as they're merged in
Any PRs merged into the release branch will be backmerged into the working branch and any upcoming release branches. This process will repeat anytime a new PR is merged into the release branch, so the working branch and upcoming release branches are always kept up to date as new work comes in.
Runway will always open a backmerge PR containing the new changes. You will be responsible for resolving any conflicts that might exist between the backmerge branch and the target branch.
Handling conflicts during a backmerge
If conflicts exist between the release branch and the target base branch, they must be manually resolved on the backmerge branch before merging. Runway will be unable to automatically merge backmerge PRs if unresolved conflicts exist in the open pull request.
Delete version-specific release branches at the end of the release cycle
Runway will delete version-specific release branches when the release is complete and tagged.
Only teams that are set up with version-specific release branches may enable this automation.
Pull (cherry-pick) fixes into the release
Runway will automatically pull fixes into the release branch by cherry-picking its commits from the working branch to the relevant release branch. Fixes flagged for cherry-pick will appear in the Feature Readiness work items list with the Fix header, and the code item will reflect the status of the cherry-pick automation.
Runway will always open a pull request with the cherry picked commits against the target release branch.
Configuration options
Cherry-pick pull request strategy:
Choose an option for how Runway should create cherry-pick PRs against the release branch.
Pull over fixes one at a time in the order in which they were merged: Runway will perform cherry-picks and open a PR for each fix one at a time in the order in which they were merged into the working branch. Pull requests containing fixes against the release branch must be merged or closed before the next fix can be pulled in. This option is best for teams looking to avoid cherry-pick merge conflicts.
Pull over fixes in the order in which they were merged, as soon as they're detected: Runway will perform cherry-picks and open PRs for fixes in the order in which they were merged into the working branch, as soon they're detected. Multiple pull requests containing fixes against the release branch can be open at the same time. This option is best for teams looking to get fixes pulled into the release branch as quickly as possible.
Pull over fixes by grouping all fixes into a single PR, in the order in which they were merged, as soon as they're detected: Runway will cherry-pick all fixes into a single PR open against the release branch. Any subsequent fixes will be cherry-picked into the same open PR branch. You must manually merge this PR once all fixes are in.
Allow PRs to be flagged as fixes using a token:
Enable pull requests to be flagged as a fix by adding a customizable text token in the PR title (e.g. runway-pick-{version}). If the text pattern contains the tokens {version} or {versionConcise}, work will be pulled in as a fix and cherry picked onto the release branch for the version specified. If the text pattern does not contain a version-specific token, tagged work will be cherry picked into the next active release version. Note that the target release version must be kicked off in order for tagged work to be pulled in.
If the merge pull requests opened by Runway automation is enabled, Runway will attempt to automatically merge the PR once possible (e.g. when all blocking checks have passed).
If the Require fix approvals setting is enabled, Runway will only merge cherry-pick PRs once the fix has been approved by a user with sufficient permissions.
Notify the original author when a PR has been cherry-picked:
Runway will mention the original author of the fix in a notification once the cherry-pick has been performed.
Squashed PRs vs. merge-commit PRs
Runway's cherry picking behavior differs slightly depending on whether the tagged PR was squashed into the working branch, or merged with a merge commit.
If the tagged pull request was squashed, Runway will cherry-pick the squashed commit from the working branch, and squash the resulting pull request against the target release branch when merging automatically.
If the tagged pull request was merged with a merge commit, Runway will cherry-pick individual commits that were part of the tagged PR and open a pull request against the target release branch with the cherry-picked commits. Note that Runway will not cherry-pick the merge commit on the working branch. If Runway is able to automatically merge the resulting pull request against the target release branch, it will merge with a merge commit by default to match the merge style of the original tagged PR.
Conflicts and cherry pick errors
Runway scans the working branch for tagged PRs and runs the cherry picking sequence for tagged PRs in the order in which they were merged. If it encounters an error during the cherry-pick sequence (either due to a conflict or for any other reason), a notification is sent to Slack or Teams with details on the error, and the automation is blocked from proceeding with further cherry-picks until the error is manually resolved.
Upload build artifacts for distribution
Runway will upload build artifacts (.ipa, .apk, or .aab files) from your CI/CD workflow artifacts to App Store Connect or the Play Console for distribution.
This automation depends on the Provide build artifacts automation being enabled. Make sure the Provide build artifacts automation is enabled if you want to enable build uploads.
To set up this automation, you’ll configure a set of rules that define which artifacts (and from which CI/CD workflows) should be uploaded to which destination. You can also configure specific filenames that Runway should select for the upload action. Each rule requires the following settings:
The kind of CI/CD workflow for the rule: this can be either the Release Candidate (RC) workflow or the Release workflow configured in your CI/CD integration settings
The file name to look for when selecting which artifact to upload: this can be a plain string or it can contain any of the supported tokens
The upload destination: this can be either the beta integration or app store integration for your app
You’ll also need to choose the Upload behavior which will define behavior when there are multiple successful CI/CD builds in a short period of time, and in case an artifact upload fails.
Upload artifacts for newest build only: If there are multiple successful CI/CD builds in a short period of time, Runway will upload artifacts for the newest available build only.
Upload artifacts for all builds – stop on failure: Artifact uploads will be attempted for all successful builds serially in order (based on the ordering of the CI/CD workflow build they’re part of). If an artifact upload fails after retry attempts, uploads for any newer builds that have finished will not be attempted.
Upload artifacts for all builds – continue on failure: Artifact uploads will be attempted for all successful builds serially in order (based on the ordering of the CI/CD workflow build they’re part of). If an artifact upload fails after retry attempts, newer builds will proceed with upload attempts in order.
If an artifact upload attempt fails, Runway will retry twice before updating the status of the artifact upload to Failed
You can see the status of artifact uploads in the Upload status module of the Artifacts section for each build.
Failed uploads can be manually retried by clicking Retry from the Upload status module of the failed build.
Upload dSYMs to your stability monitoring provider (iOS)
Runway will automatically upload dSYMs generated as part of your build process from your CI/CD workflow artifacts to your stability monitoring provider.
To set up this automation, you’ll configure a set of rules that define which CI/CD workflows the automation should apply to, and (optionally) the specific file name for your dSYM zip. By default, Runway will look for any file names matching the following pattern: {*}.dSYM.zip
Runway will always upload dSYM files to the project defined in your stability monitoring integration settings.
If your CI/CD workflow packages all artifacts into a single .zip file (the default for GitHub Actions and GitLab CI), Runway requires your dSYM artifacts to use a .dSYM.zip extension.
Customized iOS phased rollouts
Customize phased rollouts with blackout dates and times – Runway will pause and resume phased rollouts to avoid phased rollout percentage increments on the blackout dates and times you specify.
Customized Android staged rollouts
Runway will automatically increase your staged rollout percentage over the course of multiple days based on your configured settings. You can optionally specify blackout dates and times on which your staged rollout will not increment.
Configuration
To configure your incremental rollout, choose the number of days (2 - 7 days) and the staged rollout percentage for each day.
By default, the staged rollout sequence will start as soon as you release is submitted for review with Google and increment every 24 hours from that point forward according to your configured number of days. For teams that have managed publishing disabled, this default behavior works well because updates are released to users as soon as Google review passes, and Google reviews tend to be relatively quick (within a couple of hours).
However, some teams prefer to have more control over when the rollout sequence starts. This is especially important for teams that have managed publishing enabled.
The Google Play Developer API doesn't yet have support for managed publishing – this means Runway can't determine when your app was released via managed publishing.
Starting the staged rollout sequence
The Manually start custom staged rollout sequence option requires you to manually start the staged rollout sequence.
Because of an API limitation with the Google Play Developer API, manually starting the staged rollout sequence is enabled by default for all new apps, and it's highly recommended that you keep this option enabled to avoid Google review delays.
If this option is enabled, you'll see a button the Staged rollout module in the Rollout page to manually start the staged rollout sequence. The action will also be available from the Staged rollout module on the Release step.
If you have managed publishing enabled, we recommend starting the staged rollout sequence in Runway as soon as you've published your release from the Play Console.
If managed publishing is disabled, we recommend starting the staged rollout sequence in Runway as soon as you've received an email from the Play Console indicating that your release has gone live.
Blackout dates
You can also specify blackout days and times during which your staged rollout percentage will not be incremented. Runway will resume the rollout once the blackout period has ended if at least 24 hours have passed since the last time the rollout was incremented.
If you halt a staged rollout during the course of an automated rollout, you must manually resume the staged rollout and update the staged rollout percentage going forward
Prepare rollback releases
Runway will automatically prepare a rollback release alongside each regular release, which will re-sign, upload and (optionally) submit the previous stable build to have ready in case your latest release needs to be pulled back.
To enable automatic rollback submission on iOS, check the Submit automatically when all release steps are ready option. Runway will automatically submit prepared rollbacks for review as soon as the target release has gone live.
Runway can also automatically discard unused rollbacks based on conditions that you specify – for example, you could choose to discard prepared rollbacks if the target release has at least 20% adoption and retained a 95.95% crash free rate.
If a rollback has been submitted for review, discarding the rollback will developer reject the submitted rollback.
Create regression test runs
Runway will create test runs (and if needed, test plans) for each new release as soon as it's kicked off. The test runs and test plans from the previous release will be used as a template for test run and test plan creation.
This automation is only available for teams using TestRail as their regression testing integration.
Configuration
To configure this automation, first specify whether your team uses test plans. If you use test plans, you'll be prompted to add at least one test plan pattern that Runway will use to match test plans from the previous release to copy over. You'll also have the option to either copy all unique test runs found under the test plan, or to match specific test runs using patterns.
If your team does not use test plans, you must simply specify one or more test run patterns that Runway should match when copying over test runs from the previous release.
When copying test runs, all test cases found in the test run will be copied for new test runs.
Distribute release summary at the end of each release cycle
Runway will distribute a release summary via email at the end of each release cycle. The default release summary includes stats on your release like number of work items completed, number of contributors to the release, the release duration, and more. You can configure the default template from App settings > Custom strings, and you can make changes to the release summary for a specific release from the Release step up until the release has gone live.
Configuration
Add one or more email recipients for your release summary. The release summary email will be sent automatically to recipients for each release as soon as the release goes live.
Create and sync App Store Connect/Play Console versions to match current Runway release
iOS
Runway will create a new version of your app in App Store Connect once the next release is being prepared in Runway.
Android
Runway will create a draft production release in the Play Console for the current release in Runway if needed, and keep the version name in sync if the version changes in Runway.
Apply default Export Compliance Information to new builds in App Store Connect
Runway will apply your default Export Compliance Information answers (as defined in App Settings) to new builds as they are uploaded to App Store Connect.
Select the latest build in App Store Connect
Runway will select the latest available build for release in App Store Connect. Note that there may be a processing delay of a few minutes.
Runway will stop automatically selecting the latest build when:
a different build is manually selected in App Store Connect
a different build is manually selected in Runway's submission step
an RC build is manually selected as Active RC in Runway's Release candidate step, and that RC build has an associated app store build
Add the latest available APK/AAB to the draft release on the Production track in the Play Console
Runway will take the latest available APK/AAB in the Play Console, and apply it to the draft release on the production track.
You can optionally choose to limit automatic selection to APKs/AABs that are already available on a testing track that you specify.
Runway will stop automatically selecting the latest build when:
a different build is manually applied to the Production track in the Play Console
a different build is manually selected in Runway's submission step
an RC build is locked as the active RC in Runway's Release Candidate step, and that RC build has an associated app store build
Apply 'What's New' text or release notes to new releases in App Store Connect or Play Console
Runway will automatically apply 'What's new' text or release notes from your chosen source to new release versions. There are two sources for release notes that you can choose from:
Default release notes: You can define default 'What's new' text or release notes for each locale from App settings > App store defaults > Default notes. Runway will apply these default notes to each new release version.
Previous release: Runway will use the 'What's new' text or release notes from the previous release version to populate notes for the current release.
iOS
Runway will apply 'What's New' text from your chosen source to new versions created in App Store Connect. You can continue to modify the text before you submit your update for review.
Android
Runway will apply release notes from your chosen source to new versions created in the Play Console. You can continue to modify the text before you submit your update for review.
Apply default review attachment to new app versions in App Store Connect
iOS
When submitting a new release for review, Runway will apply your default file attachment provided for reviewers (as defined in App Settings) to new versions created in App Store Connect.
Promote new builds to testing track
Android
Runway will promote any newly uploaded APKs/AABs to your testing track and start the rollout.
Assign beta testing builds to default testing groups
iOS
Runway will assign any new builds uploaded to TestFlight to your default beta groups for testing. External testers will have access once the build has been reviewed.
Submit new builds for beta review
iOS
Runway will submit any new builds uploaded to TestFlight for beta review as soon as they finish processing.
Apply beta testing notes to new beta builds
Runway will apply beta testing notes to new beta builds as they become available. The source of the beta testing notes is configurable as follows:
Carry over from previous beta build: Runway will apply the beta tester notes from the previous beta build to the most recent build.
Generate changelog from diff since previous beta build: Runway will automatically generate a changelog from new work in the diff since the previous beta build.
Generate changelog from diff since last completed release: Runway will automatically generate the complete changelog since the previous release's tag.
Sync localizable string translations
Runway will upload new or updated strings for translation as needed, and export strings from the provider and open a pull request when ready.
How it works
Runway will watch the status of localizable strings on your release branch, and perform uploads and exports to and from your translations provider as needed:
Upload localizable string files to the translations provider: If Runway detects one or more source keys with an Upload needed status, it will automatically upload the necessary files to the translations provider. Only localizable string files containing one or more keys with an Upload needed status will be uploaded.
Export translations to the target branch: If Runway detects one or more source keys with an Export needed status, it will automatically export the necessary files from the translations provider and open a pull request against your configured target branch. Only files containing one or more keys with an Export needed status will be exported.
For a detailed overview of localizable string key statuses, please see the Translations step documentation.
If you export updated translations to the working branch, consider enabling the Update translations on the release branch from the working branch automation to let Runway automatically manage updating your release branch with the latest translations.
Set up
Choose a target branch for your exported translations.
If you'd like Runway to automatically trigger an upload leading up to a release's target kickoff, check the Upload localizable strings for translation ahead of release kickoff option. You'll be prompted to choose when the upload action should be triggered, as the number of days before kickoff.
If you'd like Runway to automatically trigger an export leading up to a release's target submission, check the Export translations from translations provider ahead of release submission option. You'll be prompted to choose when the export action should be triggered, as the number of days before target submission.
The Export translations from translations provider ahead of release submission will always trigger an export on the configured day for any localizable string files that contain at least one key in the Export needed state. This may result it the export of additional incomplete translations included in that file. We always recommend reviewing and approving the overall state of the Translations step prior to app submission.
Update translations on the release branch from the working branch
Runway will update translations on the release branch by pulling over new translations from the working branch as needed.
How it works
Runway will watch your working branch for changes to any localizable string files that are merged after the release has been kicked off. If it detects new translations to existing source keys, it will automatically open a PR against the release branch with all localizable string files that that contain updated translations.
If you'd like Runway to push updated translations to your release branch without a pull request, you can enable the Bypass pull requests option. Note that this requires additional configuration on your branch protection rules – detailed instructions on how to set this up for each type of VCS integration are available here.
If the Merge pull requests open by Runway automation is enabled, the PR will be automatically merged once all checks have passed. Otherwise, you will need to merge in the update PR manually.
Tag releases at the end of the release cycle
Runway will tag your production release commit at the end of each release cycle, and generate a summary of all work going out with the release. The summary will be added to a "Release" in your VCS integration, and will include a list of commits and their associated project management tickets.
Your previous release must be tagged in order for Runway to accurately compute the summary of work for a release.
Runway may fail to tag your releases automatically in certain cases:
Your previous release was not tagged
The build that was released could not be associated with a Release Candidate (CI) build, and therefore could not be linked to a specific commit in your VCS
Commit info is missing from your build in CI
In these cases, you can manually tag your release in Runway by going to the Release step, choosing a commit to tag, and clicking Create Tag.
Attach build artifacts to VCS release record when tagging
When tagging your production release commit, Runway will attach all artifacts generated from your active production build workflow as assets on your release record.
This automation requires the Provide build artifact downloads automation to be enabled. Artifact downloads are currently only supported via GitHub Actions and Bitrise.
Add missing labels or fix versions to tickets
Runway will add appropriate labels and/or fix versions when they are missing from tickets that are associated with the release. These label and fix version patterns are defined in Integration settings > Feature affiliations for the app.
Missing labels or fix versions will be applied to a ticket if a piece of code work is in a given release (exists in that release’s diff) and that piece of code work references that ticket (in commit message, PR title, or former branch name)
The missing labels or fix versions are applied once code work enters the final release diff (i.e. exists on the release branch and is in the diff for the release).
Mark releases complete in project management tool
Runway will mark releases as completed in your project management tool at the end of each release cycle.
This automation is currently only supported for Jira project management integrations.
Update status of issue tracking tickets upon release completion
Runway will update all issue tracking tickets associated with the release to the configured status upon release completion.
Provide build artifact downloads and notify when available
Runway will download all artifacts generated from your CI build workflow, and provide direct download links to them from the Runway interface. Additionally, Runway will include artifact information in Slack or Teams build success notifications, including a link to find those downloads in Runway.
Artifact downloads are currently only supported on apps set up with GitHub Actions, Bitrise, CircleCI, GitLab or Codemagic as their CI/CD integration.
Merge pull requests opened by Runway
Runway may create pull requests to fulfill various tasks on demand (for example, bumping your version in code on a development branch). If this automation is enabled, Runway will attempt to merge these PRs without manual approval.
Prepare next version in Runway when current release is kicked off
Runway will create a new Runway release record for your next upcoming version as soon as your current release is kicked off.
Runway will use your app's default release type to predict the correct version for your next release.
Sync users and roles from Runway to App Store Connect / Play Console
Runway can automatically manage adding and removing users from App Store Connect and Play Console. This automation can be enabled at the Runway role level to invite users with specific roles to the appropriate store, and grant them the appropriate roles and permissions.
When users are removed from your app in Runway, they will also be removed from the corresponding store. This option is configurable, and can be disabled from the automation's settings.
The roles and permissions granted to users are based on the mapping of Runway roles to App Store Connect roles or Play Console permissions. See below for the default values of this mapping for each platform.
You can configure your own custom mapping rules for each app under App Settings > Team roles.
iOS
Users in Runway will automatically be invited to your app in App Store Connect, and assigned the appropriate roles based on their Runway roles.
The App Store Connect API key in use by Runway must have the "Admin" role in order to enable user sync.
Default mapping of Runway role to ASC role:
| Runway Role | Default role on App Store Connect |
|---|---|
Admin | Admin |
EM | App Manager |
PM | App Manager |
Engineer | Developer |
Design | Marketing |
Ops | Customer Support |
Marketing | Marketing |
CX | Customer Support |
QA | Customer Support |
Approver | Customer Support |
For additional details on Apple Developer Program roles and associated permissions, see Apple’s documentation.
Removing users
If a user is removed from your app in Runway, and the option to remove users from App Store Connect is enabled, Runway will revoke access to the corresponding app in App Store Connect.
Android
Users in Runway will automatically be invited to your app in Google Play Console, and be granted the appropriate permissions based on their Runway roles.
You must update the permissions on the service account associated with your Runway Play integration to “Admin” in order to enable user sync. You can do this by visiting API Access > View Play Console permissions > Account permissions and selecting "Admin"
Default mapping of Runway role to permissions on the Play Console:
| Runway Role | Play Console Permissions |
|---|---|
Admin | Admin (all permissions) |
EM |
|
PM |
|
Engineer |
|
Design |
|
Ops |
|
Marketing |
|
CX |
|
QA |
|
Approver |
|
For additional details on the Google Play Console’ developer account users and managing permissions, visit their documentation.
Removing users
If a user is removed from your app in Runway, and the option to remove users from the Play Console is enabled, Runway will revoke access to the corresponding app in Play Console.
Sync Slack groups
Runway will add and remove users from Slack groups based on their user roles in Runway. You can configure the mapping of user roles to Slack groups from App settings > Team > Runway user roles to Slack groups.
The Slack groups sync automation runs on a regular interval – updates may take up to 10 minutes to be applied.
Sync provisioning profile devices
This automation is available for iOS platforms only.
Runway will sync valid provisioning profiles in the Apple Developer Portal to add and remove user devices when needed.
To configure this automation, choose which types of provisioning profiles Runway should sync.
Only iOS Ad Hoc and iOS Development provisioning profiles can specify devices – In House and App Store provisioning profiles cannot include associated devices.
Additionally, you can choose specific roles that users must have in order for their devices to be automatically synced with provisioning profiles.
To enable Runway to remove the devices of users that are removed from apps in Runway from valid provisioning profiles, keep the Remove devices for users that are removed from apps in Runway option checked.
In order to use this automation, the App Store Connect API key associated with your app in Runway must have an Admin or Account Holder role.
Sync devices in the Apple Developer Portal
This automation is available for iOS platforms only.
Runway will register and enable new devices with the Apple Developer Portal, and disable them when the associated app users are removed from the app in Runway.
To configure this automation, choose specific roles that users must have in order for their devices to be automatically registered and enabled in the Apple Developer Portal. Test devices added to apps in Runway can also be optionally synced automatically in the Apple Developer Portal.
To enable Runway to disable the devices of users that are removed from apps in Runway, keep the Disable devices for users that are removed from apps in Runway option checked.
In order to use this automation, the App Store Connect API key associated with your app in Runway must have an Admin or Account Holder role.
Post installation QR codes on open PRs
This automation is only available for apps using GitHub as their VCS integration.
Runway will post an installation QR code on open PRs any time a new Build Distro bucket build is available for installation.
The bucket must be configured with a PR rule to pull in builds from open PRs against a base branch.
Generate tester notes from the work items diff
Runway will generate and apply build tester notes for new Build Distro bucket builds using the work items diff for the build.
Trigger build workflow
Runway will trigger a build workflow run automatically as needed based on your bucket configuration.
For buckets configured with a Branch rule, workflow runs are triggered anytime a commit is pushed to a matching branch, using the specified workflow. If the rule includes a user filter, only commits pushed to a matching branch by one of the specified users will trigger a new workflow run.
For example, the following bucket configuration would trigger a new tab-ios/build workflow run anytime a commit is pushed to the development branch.
For buckets configured with a PR rule, workflow runs are triggered anytime a commit is pushed to a branch that's associated with an open PR against a matching base branch. If the rule includes a user filter, only commits pushed to branches that are assocaited with an open PR created by one of the specified users will trigger a new workflow run.
For example, the following bucket configuration would trigger a new tab-ios/adhoc workflow run anytime a commit is pushed to a branch associated with an open PR against the main branch.
How to enable pull request bypass for Runway
By default, any time a Runway automation modifies code in your repository, it will open a pull request with the changes. If you have the Merge pull requests opened by Runway automation enabled, it will attempt to merge the pull request as soon as all checks have passed. However, in many cases teams choose to protect certain branches with required pull requests and lengthy integration checks, and Runway cannot merge open PRs until all of the requirements for the pull request have been met.
Certain Runway automations surface an option to Bypass pull requests and allow Runway to commit and push changes to the target branch directly. Teams may choose to enable this option if code changes are relatively trivial and harmless (e.g. version bumps) and they would prefer not to need to meet strict pull request criteria for these kinds of changes.
If a target branch has branch protections enabled, and the branch protections require pull requests for merging or restrict pushes to the target branch, you must first update the branch protection settings in your VCS in order for the Bypass pull requests automation setting to function properly.
How to update branch protection settings in GitHub
To allow Runway to bypass required pull requests for your target branch, follow these steps:
Navigate to your repository settings in GitHub
Select Code and automation -> Branches and find the branch protection rule for the target branch you'd like to allow Runway to bypass pull requests for
Under the Require a pull request before merging option, make sure that the setting Allow specified actors to bypass required pull requests is enabled
Under the Allow specified actors to bypass required pull requests setting, add the "Runway + GitHub" app to the list of apps allowed to bypass pull requests for the branch
Under the Restrict who can push to matching branches setting, add the "Runway + GitHub" app to the list of apps allowed to push to the protected branch
Ensure Runway can run status checks if needed
If your branch protection rule additionally has the Require checks to pass before merging option enabled, Runway will need to first push changes to a branch so status checks can be run before automatically merging. In order to support this, your status checks must be configured to run on push for branches matching the pattern runway-check-*. This will let status checks run on Runway-created branches, which will enable Runway to automatically merge changes into protected branches.
How to update branch protection settings in GitLab
To enable Runway to bypass merge requests in GitLab and push directly to a target branch, follow these steps:
In GitLab, select Main menu > Projects and find your project
On the left sidebar, select Settings > Repository
Expand Protected branches
From the Branch dropdown list, select the target branch
From the Allowed to push list, select the user that originally installed the GitLab integration in Runway
GitLab's integration with Runway is OAuth-based, which means that the integration's scopes and permission are tied to those of the GitLab user that ran through the OAuth flow in Runway. To avoid unintentionally granting push access to a specific user (and to avoid integration issues if that user leaves the company), we strongly suggest setting up a service account user to use for authentication between GitLab and Runway.
How to update branch protection settings in Bitbucket
To enable Runway to bypass pull request restrictions on Bitbucket and push directly to a target branch, follow these steps:
Go to a repository in a project
Choose Settings > Branch permissions and select the target branch
Under the Prevent changes without a pull request except by: restriction, select the user that originally installed the Bitbucket integration in Runway
Bitbucket's integration with Runway is OAuth-based, which means that the integration's scopes and permission are tied to those of the Bitbucket user that ran through the OAuth flow in Runway. To avoid unintentionally granting push access to a specific user (and to avoid integration issues if that user leaves the company), we strongly suggest setting up a service account user to use for authentication between Bitbucket and Runway.
Last updated
