From 5c51ecd7ba56e0455e8faf35d7f04a0daeeaf46e Mon Sep 17 00:00:00 2001 From: zoltan-baba Date: Wed, 26 Aug 2026 15:10:26 +0200 Subject: [PATCH] Fix doc-vs-implementation staleness in release-management/releases Docs-vs-implementation validation flagged 16 stale claims in the Releases section (button/dialog renames, a retired webhook field name, two stale screenshots, and several paraphrased UI labels). Corrects all of them against the current bitrise-website implementation. Co-Authored-By: Claude Sonnet 5 --- .../release-management/releases/adding-a-new-release.mdx | 4 +++- .../configuring-slack-and-teams-notifications.mdx | 1 + .../configuring-a-release/deleting-a-release.mdx | 4 ++-- .../outgoing-webhooks-in-release-management.mdx | 7 +++---- .../about-the-release-process.mdx | 4 ++-- .../creating-tasks-for-the-approvals-stage.mdx | 6 +----- .../releasing-your-app-on-google-play.mdx | 6 +++--- .../releasing-your-app-on-the-app-store.mdx | 2 +- .../selecting-a-release-candidate.mdx | 4 ++-- .../sending-your-app-to-app-store-review.mdx | 2 +- .../stop-managing-a-release.mdx | 9 ++++----- docs/release-management/releases/release-presets.mdx | 2 +- 12 files changed, 24 insertions(+), 27 deletions(-) diff --git a/docs/release-management/releases/adding-a-new-release.mdx b/docs/release-management/releases/adding-a-new-release.mdx index 5057f029..58281532 100644 --- a/docs/release-management/releases/adding-a-new-release.mdx +++ b/docs/release-management/releases/adding-a-new-release.mdx @@ -20,7 +20,9 @@ To add a new release to [a connected app](/release-management/getting-started-wi The release description is internal only, and it will not be included in the App Store review submission (metadata). ::: -1. Select a template from the **Preset template** dropdown menu. +1. Choose whether to **Apply a template** (pre-fill release settings) or **Start with a blank release** (no presets applied). + + If you choose **Apply a template**, select a template from the **Preset template** dropdown menu. You can configure templates in [Release presets](/release-management/releases/release-presets). 1. Click **Add app version**. diff --git a/docs/release-management/releases/configuring-a-release/configuring-slack-and-teams-notifications.mdx b/docs/release-management/releases/configuring-a-release/configuring-slack-and-teams-notifications.mdx index 09622210..e0364782 100644 --- a/docs/release-management/releases/configuring-a-release/configuring-slack-and-teams-notifications.mdx +++ b/docs/release-management/releases/configuring-a-release/configuring-slack-and-teams-notifications.mdx @@ -33,6 +33,7 @@ You can configure notifications for each individual release: 1. Click the options menu (⋮) next to **Slack**. ![2025-08-08-rm-slack-notification.png](/img/_paligo/uuid-40c38dac-74da-dcc2-0e07-64366c2732dc.png) +1. Click **Change configuration**. 1. In the dialog, select your previously configured Slack configuration. :::tip[Test notification] diff --git a/docs/release-management/releases/configuring-a-release/deleting-a-release.mdx b/docs/release-management/releases/configuring-a-release/deleting-a-release.mdx index 84d021be..77e96cf8 100644 --- a/docs/release-management/releases/configuring-a-release/deleting-a-release.mdx +++ b/docs/release-management/releases/configuring-a-release/deleting-a-release.mdx @@ -21,5 +21,5 @@ Your data in TestFlight, App Store Connect, or Google Play will not be lost, and To delete a release: 1. -1. Scroll down to the **Delete release** section, and click **Delete release**. -1. In the dialog, click **Delete** to confirm. +1. Scroll down to the **Delete release** section, and click **Remove release**. +1. In the dialog, click **Remove** to confirm. diff --git a/docs/release-management/releases/configuring-a-release/outgoing-webhooks-in-release-management.mdx b/docs/release-management/releases/configuring-a-release/outgoing-webhooks-in-release-management.mdx index bef11d3d..62128376 100644 --- a/docs/release-management/releases/configuring-a-release/outgoing-webhooks-in-release-management.mdx +++ b/docs/release-management/releases/configuring-a-release/outgoing-webhooks-in-release-management.mdx @@ -128,7 +128,6 @@ Multiple release automation events can trigger a webhook. All webhooks contain t | `triggered_by` | Either a user slug or one of: `Automation`, `Apple App Store`, `Google Play Store` | | `trigger_event` | | | `webhook_config_id` | | -| `webhook_connection_id` | | | `webhook_event_unique_id` | `WEBHOOK_ID@TRIGGER_TIMESTAMP_NANO` | | `workspace_id` | | @@ -144,9 +143,9 @@ The following webhook events are available. The **Fields** column contains the a | Microsoft Teams connection changed | `microsoft_teams_connection_changed` | | | Automation added | `automation_added` | - `event_name` - `pipeline_name` - `workflow_name` | | Automation removed | `automation_removed` | - `event_name` - `pipeline_name` - `workflow_name` | -| Outgoing webhook added | `outgoing_webhook_added` | - `all_events` Available values: `true/false` - `events`: Listed only if `all_events` are false. - `workspace_webhook_id` | -| Outgoing webhook updated | `outgoing_webhook_updated` | - `all_events` true/false - `events`: Listed only if `all_events` are false - `workspace_webhook_id` | -| Outgoing webhook deleted | `outgoing_webhook_deleted` | - `all_events` Available values: `true/false` - `events` Listed only if `all_events` are false - `workspace_webhook_id` | +| Outgoing webhook added | `outgoing_webhook_added` | - `all_events` Available values: `true/false` - `events`: Listed only if `all_events` are false. - `webhook_configuration_id` | +| Outgoing webhook updated | `outgoing_webhook_updated` | - `all_events` true/false - `events`: Listed only if `all_events` are false - `webhook_configuration_id` | +| Outgoing webhook deleted | `outgoing_webhook_deleted` | - `all_events` Available values: `true/false` - `events` Listed only if `all_events` are false - `webhook_configuration_id` | | Stopped managing release | `stopped_managing_release` | - `reason_for_stopping` Available values: `abandoned/completed externally` | | Release candidate source changed | `release_candidate_source_changed` | - `from_source` Available values: `ci/api/empty string` - `to_source` Available values: `ci/api` - `from_branch`: Only if the value of `from_source` is `ci` - `from_workflow`: Only if the value of `from_source` is `ci`. - `to_branch`: Only if the value of `to_source` is `ci`. - `to_workflow`: Only if the value of `to_source` is `ci`. | | Release candidate auto select latest build disabled | `release_candidate_auto_select_latest_build_disabled` | | diff --git a/docs/release-management/releases/managing-the-release-process/about-the-release-process.mdx b/docs/release-management/releases/managing-the-release-process/about-the-release-process.mdx index 9a6e729d..2fa21aff 100644 --- a/docs/release-management/releases/managing-the-release-process/about-the-release-process.mdx +++ b/docs/release-management/releases/managing-the-release-process/about-the-release-process.mdx @@ -22,9 +22,9 @@ Android 1. [TestFlight](/release-management/releases/managing-the-release-process/testflight-upload-stage#uploading-the-release-candidate-to-testflight): Upload the release candidate to TestFlight, and distribute it for testing. 1. [Approvals](/release-management/releases/managing-the-release-process/creating-tasks-for-the-approvals-stage): You can create tasks for any stakeholder or team member whose approval is needed to continue with the release to the App Store. 1. [App Store review](/release-management/releases/managing-the-release-process/sending-your-app-to-app-store-review): Submit your update to review in the App Store, and get information on the approval progress. -1. [Release on the App Store](/release-management/releases/managing-the-release-process/releasing-your-app-on-the-app-store): You can release your app to all users at the same time, or configure a phased release. +1. [Release](/release-management/releases/managing-the-release-process/releasing-your-app-on-the-app-store): You can release your app to all users at the same time, or configure a phased release. 1. [Release candidate](/release-management/releases/managing-the-release-process/selecting-a-release-candidate): In the **Release candidate** stage, specify the release branch and select the Workflow that generates an AAB file. 1. [Google Play upload and testing](/release-management/releases/managing-the-release-process/google-play-upload-stage#uploading-the-release-candidate-to-google-play): Upload the release candidate to Google Play, and distribute it for testing. 1. [Approvals](/release-management/releases/managing-the-release-process/creating-tasks-for-the-approvals-stage): You can create tasks for any stakeholder or team member whose approval is needed to continue with the release to Google Play. -1. [Release on Google Play](/release-management/releases/managing-the-release-process/releasing-your-app-on-the-app-store): You can release your app to all users at the same time, or configure a staged rollout. +1. [Release](/release-management/releases/managing-the-release-process/releasing-your-app-on-the-app-store): You can release your app to all users at the same time, or configure a staged rollout. diff --git a/docs/release-management/releases/managing-the-release-process/creating-tasks-for-the-approvals-stage.mdx b/docs/release-management/releases/managing-the-release-process/creating-tasks-for-the-approvals-stage.mdx index f7b0d496..36c5461d 100644 --- a/docs/release-management/releases/managing-the-release-process/creating-tasks-for-the-approvals-stage.mdx +++ b/docs/release-management/releases/managing-the-release-process/creating-tasks-for-the-approvals-stage.mdx @@ -11,9 +11,7 @@ Optionally, you can assign an approval task to a team member. Only the assigned 1. Open your release. 1. Select **Approvals** on the left navigation bar. - - ![approvalpage_tasks.jpg](/img/_paligo/uuid-1c68a37c-df87-a7ef-90e6-37ca83ac1ba2.jpg) -1. Click the **Add New Task** button. +1. Click the **New task** button. 1. Fill out the necessary fields: ![add_approval_task.png](/img/_paligo/uuid-97e3fccd-f3f6-fdc8-5f55-75f85a525e95.png) @@ -25,8 +23,6 @@ Optionally, you can assign an approval task to a team member. Only the assigned You can create as many tasks as you want. -![approvalteam.png](/img/_paligo/uuid-2b430e36-ee56-c8ce-3599-f267c550062a.png) - 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. When done, you can proceed to: diff --git a/docs/release-management/releases/managing-the-release-process/releasing-your-app-on-google-play.mdx b/docs/release-management/releases/managing-the-release-process/releasing-your-app-on-google-play.mdx index 12927aff..817bceaa 100644 --- a/docs/release-management/releases/managing-the-release-process/releasing-your-app-on-google-play.mdx +++ b/docs/release-management/releases/managing-the-release-process/releasing-your-app-on-google-play.mdx @@ -44,7 +44,7 @@ You can clear the schedule before the first stage of the scheduled rollout is co You can cancel the automated rollout at any time after the first stage of the rollout is completed. However, once the automation is cancelled, you can't resume it and you can only update it manually in Release Management. 1. Open your release. -1. Go to the **Release app version** stage. +1. Go to the **Release** stage. 1. Find the **Release summary** section. 1. Click the **Cancel automation** button. @@ -55,7 +55,7 @@ You can cancel the automated rollout at any time after the first stage of the ro You can pause and resume the automated rollout at any time after the first stage of the rollout is completed. There’s no limit to the number of pauses or the duration of the pause. 1. Open your release. -1. Go to the **Release app version** stage. +1. Go to the **Release** stage. 1. Go to **Staged rollout**. 1. Click **Pause automation**. @@ -99,7 +99,7 @@ Please note that only [Release Managers](https://devcenter.bitrise.io/en/release To modify the release note of an Android app during the release process: -1. Go through the **Release candidate**, **Google Play**, and **Approvals** stages, then click **Release app version** on the left. +1. Go through the **Release candidate**, **Google Play**, and **Approvals** stages, then click **Release** on the left. 1. Scroll down to **Release note** and click **Edit**. You can see the default release note content in the text box. 1. Make your changes to the text. This new content will apply for the localization under **Language**. 1. You can copy the new content to additional localizations by clicking **Copy to** and selecting other localizations. diff --git a/docs/release-management/releases/managing-the-release-process/releasing-your-app-on-the-app-store.mdx b/docs/release-management/releases/managing-the-release-process/releasing-your-app-on-the-app-store.mdx index 6f658f88..b9e07808 100644 --- a/docs/release-management/releases/managing-the-release-process/releasing-your-app-on-the-app-store.mdx +++ b/docs/release-management/releases/managing-the-release-process/releasing-your-app-on-the-app-store.mdx @@ -45,7 +45,7 @@ You can enable phased release before the App Store review stage or during the re - **Manually release this version** - **Automatically release this version** - - **Automatically release this version after App Review, not earlier than** and set a date. + - **Automatically release this version after App Review, no earlier than** and set a date. ![release-version.png](/img/_paligo/uuid-4f7e400b-3a64-eb42-5b85-c51a3f41da03.png) 1. On the **Release** stage, find the **Phased release for automatic updates** card, and click **Change**. diff --git a/docs/release-management/releases/managing-the-release-process/selecting-a-release-candidate.mdx b/docs/release-management/releases/managing-the-release-process/selecting-a-release-candidate.mdx index 5642a478..d25e9503 100644 --- a/docs/release-management/releases/managing-the-release-process/selecting-a-release-candidate.mdx +++ b/docs/release-management/releases/managing-the-release-process/selecting-a-release-candidate.mdx @@ -23,7 +23,7 @@ To select a release candidate: 1. Open your release. 1. Select **Release candidate** on the left navigation bar. -1. Configure the source of the build artifact: under the **Configuration** section, click **Configure**. +1. Configure the source of the build artifact: click **Configure**. This will open up the **Build artifact source** dialog. @@ -32,7 +32,7 @@ To select a release candidate: - **Use Bitrise CI builds**: Select a branch and a Workflow to use artifacts generated by a Bitrise CI build. - **Upload via API**: To be able to select an artifact from this source, [upload one using the API](/bitrise-ci/api/managing-build-artifacts). -1. Check the **Automatically select** checkbox to use either the latest generated artifact or the latest file uploaded via the API. +1. Check the **Automatically select latest successful build** checkbox (labeled **Automatically select after successful upload** if you're using the API source) to use either the latest generated artifact or the latest file uploaded via the API. Either way, the artifact must be a signed artifact. 1. Click **Save changes**. diff --git a/docs/release-management/releases/managing-the-release-process/sending-your-app-to-app-store-review.mdx b/docs/release-management/releases/managing-the-release-process/sending-your-app-to-app-store-review.mdx index 6580ca49..d30f5832 100644 --- a/docs/release-management/releases/managing-the-release-process/sending-your-app-to-app-store-review.mdx +++ b/docs/release-management/releases/managing-the-release-process/sending-your-app-to-app-store-review.mdx @@ -31,7 +31,7 @@ After you’ve uploaded your release candidate to TestFlight and the build proce :::tip[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 want to modify the release while it's under App Store review, you first need to remove it from review. Click **Remove from review** on the **To modify this release, remove it from review first** note, then confirm in the dialog. ::: diff --git a/docs/release-management/releases/managing-the-release-process/stop-managing-a-release.mdx b/docs/release-management/releases/managing-the-release-process/stop-managing-a-release.mdx index c75abe93..e0332b0a 100644 --- a/docs/release-management/releases/managing-the-release-process/stop-managing-a-release.mdx +++ b/docs/release-management/releases/managing-the-release-process/stop-managing-a-release.mdx @@ -21,11 +21,10 @@ To stop managing a release: 1. Scroll down and click **Stop managing release**. This brings up a dialog. ![2025-08-08-rm-stop-managing-release.png](/img/_paligo/uuid-187924e0-afdb-8c78-53fe-809168944982.png) -1. Select a reason for stopping this release. +1. In the **Update status and stop managing release** dialog, choose a new **Release status**: - ![2025-08-08-rm-stop-managing-release-dialog.png](/img/_paligo/uuid-b2fabd61-e0f2-af2c-3074-70940d45d4cc.png) - - - **Completed externally**: The release will be completed outside of Bitrise, either on App Store Connect or on Google Play Console. + - **Completed (App Store)** / **Completed (Google Play)**: The release will be completed outside of Bitrise, on App Store Connect or Google Play Console respectively. - **Abandoned**: The release is stopped on this stage and will not be completed. In both cases, the release turns to a read-only status on Bitrise. +1. Click **Confirm status change**. -After you confirm the changes, you can see a breakdown of all completed and not completed release stages. If you go back to the **Releases** page, you will see the stopped release with the status **Stopped managing** and a short explanation (**Abandoned**, **Completed externally**) you set before. +After you confirm the changes, you can see a breakdown of all completed and not completed release stages. If you go back to the **Releases** page, you will see the stopped release with the status **Abandoned** or **Completed (App Store)** / **Completed (Google Play)**, matching the status you set before. diff --git a/docs/release-management/releases/release-presets.mdx b/docs/release-management/releases/release-presets.mdx index f1f174f4..68773733 100644 --- a/docs/release-management/releases/release-presets.mdx +++ b/docs/release-management/releases/release-presets.mdx @@ -135,7 +135,7 @@ If you don't want to automatically use the same preset for all localizations, yo ![20251216-rm-presets.png](/img/_paligo/uuid-bf243542-7a52-3b3e-e6d5-26d0248c3951.png) 1. Click the options menu (⋮) next to the name of your template and select **Change**. 1. Find **Release notes**. -1. Click **Copy to**. This opens the **Copy metadata** dialog. +1. Click **Copy to**. This opens the **Copy release notes** dialog. ![copy-metadat.png](/img/_paligo/uuid-55c4990e-7f00-98a4-fa17-c3a9d0e3ba76.png) 1. Open the **Copy to** dropdown menu, and select all localizations you want to copy to.