GitHub

Set up

Navigate to the Integration settings view

1. Select an app in the top left corner from the Switcher

2. Navigate to App Settings by clicking the gear icon (⚙️) at the top of the Timeline sidebar

3. Click on Integrations in the sidebar

Connect GitHub

• Find the GitHub integration module under the Version control section

• Click the Connect button

• You’ll be taken through a standard GitHub app OAuth flow

  • Select one or more repos to grant access to

You must be logged in as a GitHub user with admin permissions in selected repo, or as an owner in the GitHub org.

• GitHub redirects you back to Runway

  • If you granted access to more than one repo, Runway will present you with a dropdown to select a specific repo

Add a release tag pattern

• Runway uses this to read tags from GitHub and delineate your releases, and also to generate tags when auto-tagging releases upon completion

• Pattern accepts the string {version} as a stand-in for the release version, e.g. v{version}

Runway expects version strings that adhere to Semantic Versioning principles — formatted as x.y.z (representing major.minor.patch).

Add a release branch pattern

• For GitFlow or similar, pattern accepts the string {version} as a stand-in for the release version, e.g. release-ios-{version}

  • You can assign different patterns to different types of releases using the Release type dropdown

• Omit pattern for trunk-based, e.g. main

  • Be sure to select all types in the Release type dropdown

Add any additional branches

• Working branch: your main working branch, e.g. development

• Staging branch: if you create your Release Candidate builds from a branch other than your release branch, set that here

• Deploy branch: if you create your final builds from some branch other than your release branch, set that here