Skip to main content

Configuring a release

After adding a release, you are automatically taken to the release configuration page.

Managing_releases.png

You can also reach this page from the Releases page by clicking on the "project_selector_arrow.png" button next to a release.

upcoming_releases.png

You can use the menu options on the left navigation bar to switch between the configuration of the release and the release stages. Each of these options enables you to manage your release in different ways:

  • Configuration: Edit your release description, schedule release stages, and delete the release.

  • Release candidate: Specify which branch you want to release from, and a Workflow that can generate an .xcarchive file (for example, with the Xcode Archive & Export for iOS Step).

  • TestFlight upload: Upload the selected Release Candidate to TestFlight (App Store Connect).

  • Approvals: Create tasks for each stakeholder and/or team member whose approval is needed to continue with the App Store review.

  • App Store review: Send your app to App Store review.

  • Release: Monitor the status of an automatic release or manage the release of your app.

After completing a stage, it will have a green checkmark next to it on the left menu. After finishing all stages your app will be released.

Editing the description of a release

To edit the description of an existing release:

Release description is internal only

The release description is internal only, and it will not be included in the App Store review submission (metadata).You can modify the description of your release anytime in the Release Configuration window after creating the release.

  1. Open the release configuration page of a release.

  2. Select Configuration on the left navigation bar.

  3. Click on the Edit information button to open the Edit Release details window.

  4. After updating the description, click Save.

Scheduling stages for the release

You can set up a timeline for the main stages of your release to transparently communicate to your team when each stage will be expected to be finished.

To do so:

  1. Open the release configuration page of a release.

  2. Select Configuration on the left navigation bar.

  3. Click on Schedule stages.

  4. In the Edit Timeline window, fill out each relevant stage's target date.

    edit_timeline.png
  5. Click Save.

Deleting a release

Deleting a release is permanent!

Deleting a release is irreversible and you will lose all data of the release in Release Management.

Your data in TestFlight and in App Store Connect will not be lost, and ongoing processes in the App Store will not be affected. App Store review will not be canceled. The app will be automatically released as configured.

If you want to delete a release, follow these steps:

  1. Open the release configuration page of a release.

  2. Select Configuration on the left navigation bar.

  3. Scroll down to the Danger zone section, and click on Delete release.

  4. Click Delete once more to confirm.

Selecting a release candidate for the release candidate stage

In the release candidate stage you can specify a release branch, and select a Workflow that can generate an .ipa or an .xcarchive file. (for example, with the Xcode Archive & Export for iOS Step).

You can also choose to automatically upload a new release candidate each time you finish a build on the selected release branch with the specified Workflow.

To select a release candidate:

  1. Open the release configuration page of a release.

  2. Select Release candidate on the left navigation bar.

  3. Under the Configuration section, click on the Change button.

    This will open up the Configure release candidate window.

    rc.png
  4. Select a Release Branch and a Workflow using their respective dropdown menus.

    Selecting a Workflow

    Make sure that the Workflow you selected can generate either an .ipa or an .xcarchive file and that it can deploy Artifacts. The easiest way to ensure that is to add the following Steps to your Workflow:

  5. If you want to upload all successful builds to TestFlight, click the radio button next to Upload all successful builds automatically.

  6. Click Done.

  7. If you opt to manually upload a selected build to use as the release candidate, you can do so by scrolling down to the Available builds section and toggling the Lock as RC next to the build. The selected build will be added to Active Build section.

    If you don't use the toggle to lock a build as the release candidate, the latest build will be added to the Active Build section.

    lock_rc.png

You can create additional tasks under the Checklists option.

When you have selected a release candidate and all tasks have been ticked off, Release candidate will be ticked off as well on the left navigation bar.

Uploading the release candidate to TestFlight for the TestFlight upload stage

Upload all successful builds automatically

If you select the option to upload all successful builds automatically in the release candidate stage, this stage will be completed automatically.

If you select the option to upload the selected build manually in the release candidate stage, you can continue with uploading the selected release candidate to TestFlight (App Store Connect):

  1. Open the release configuration page of a release.

  2. Select TestFlight upload on the left navigation bar.

  3. Click the Upload to TestFlight button.

  4. Wait for the upload to finish.

    upload_to_testflight.png

You can create additional tasks under the Checklists option.

When you have uploaded a release candidate to TestFlight and all tasks have been ticked off, TestFlight upload will also be ticked off on the left navigation bar.

Creating tasks for the approvals stage

You can create tasks for each stakeholder and/or team member whose approval is needed to continue with the release to the App Store Connect.

To do so:

  1. Open the release configuration page of a release.

  2. Select Approvals on the left navigation bar.

  3. Click the Add New Task button.

  4. Fill out the necessary fields, and click Save.

You can create as many tasks as you want. "The release candidate is approved and can be released" task is created by default.

After finishing a task in the approvals stage, you can tick it off using the checkbox next to the task. When all tasks have been ticked off, Approvals will be ticked off as well on the left navigation bar.

Sending your app to App Store review for the App Store review stage

After you’ve uploaded your release candidate to TestFlight and the build processing is finished, you can submit it for App Store review, where Apple will review your release:

  1. Open the release configuration page of a release.

  2. Select App Store review on the left navigation bar.

  3. Scroll down and click on Edit settings to specify how Apple should release your version after the approval process.

    release_settings.png
  4. Choose if you want to phase your release under Phased release for automatic updates.

    If you opt for a phased release, at first, only some of your users will have access to the contents of your release. Gradually, over a 7-day period, all of your users will get access.

  5. Click Save changes.

  6. Check the box next to I have revised the metadata for this version in App Store Connect.

  7. Click Submit to App Review.

    Canceling App Store review

    You can cancel the App Store review before it finishes by clicking on the Cancel App Store review button.

If you selected Automatically release this version, your app will be released as soon as Apple finishes the app review process. Your app will only be released after the date you specified under Your local date and time if you selected Automatically release this version after the App Review, no earlier than .

You can monitor the release status on the Release page.

You can proceed to Releasing your app for the Release stage for manual releases.

Releasing your app for the Release stage

If you have selected Manually release this version in the App Store review stage, you can release your app the following way:

  1. Open the release configuration page of a release.

  2. Select Release on the left navigation bar.

  3. Click the Release app button.

    release_manually.png

And that's it! Your app will be released shortly!

Changing the date of an automatic release

You can change the date on the Release page if you selected Automatically release this version after App Review, no earlier than in the App Store review stage.