kopia lustrzana https://github.com/meshtastic/Meshtastic-Android
docs: update release process for promotion strategy (#3017)
Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>pull/3022/head
James Rich
GitHub
rodzic
62a64589e2
commit
f6eff0bc55
|
|
@ -1,144 +1,104 @@
|
|||
# Meshtastic-Android Release Process
|
||||
|
||||
zzThis document outlines the steps for releasing a new version of the Meshtastic-Android application. Adhering to this process ensures consistency and helps manage the release lifecycle, leveraging automation via the `release.yml` GitHub Action.
|
||||
This document outlines the steps for releasing a new version of the Meshtastic-Android application. Adhering to this process ensures consistency and helps manage the release lifecycle, leveraging automation via the `release.yml` GitHub Action.
|
||||
|
||||
**Note on Automation:** The `release.yml` GitHub Action is primarily triggered by **pushing a Git tag** matching the pattern `v*` (e.g., `v1.2.3`, `v1.2.3-open.1`). It can also be manually triggered via `workflow_dispatch` from the GitHub Actions UI (select the desired branch/tag/commit).
|
||||
**Note on Automation:** The `release.yml` GitHub Action is primarily triggered by **pushing a Git tag** matching the pattern `v*` (e.g., `v1.2.3`, `v1.2.3-open.1`). It can also be manually triggered via `workflow_dispatch` from the GitHub Actions UI.
|
||||
|
||||
The workflow automatically:
|
||||
* Determines version information (version name from the tag, version code via a script).
|
||||
* Builds F-Droid (APK) and Google (AAB, APK) artifacts in parallel.
|
||||
* Determines version information from the tag.
|
||||
* Builds F-Droid (APK) and Google (AAB, APK) artifacts.
|
||||
* Generates a changelog.
|
||||
* Creates a **draft GitHub Release**. The release is marked as a "pre-release" if the tag name contains `-internal`, `-closed`, or `-open`.
|
||||
* Attaches build artifacts, `version_info.txt`, and `changelog.txt` to the draft GitHub Release.
|
||||
* Creates a **draft GitHub Release** and attaches the artifacts.
|
||||
* Attests build provenance for the artifacts.
|
||||
* Uploads the AAB to the Google Play Console as a **draft** to a track determined by the tag name:
|
||||
* `internal` (for tags with `-internal`)
|
||||
* `NewAlpha` (for tags with `-closed`)
|
||||
* `beta` (for tags with `-open`)
|
||||
* `production` (for tags without these suffixes)
|
||||
* Deploys to the Google Play Console using a smart **"promote-or-upload"** strategy based on the Git tag:
|
||||
|
||||
Finalizing and publishing the GitHub Release and the Google Play Store submission are **manual steps**.
|
||||
* **Internal Release (`vX.X.X-internal.Y`):**
|
||||
* Always **uploads** the AAB to the `internal` track. The release is automatically finalized and rolled out to internal testers.
|
||||
|
||||
* **Promotions (`-closed`, `-open`, production):**
|
||||
* The workflow first attempts to **promote** an existing build from the previous track. The promotion path is: `internal` -> `NewAlpha` (closed) -> `beta` (open) -> `production`.
|
||||
* **Fallback Safety Net:** If a promotion fails (e.g., the corresponding build doesn't exist on the source track), the workflow **will not fail**. Instead, it automatically falls back to **uploading** the newly built AAB directly to the target track as a **draft**.
|
||||
|
||||
This fallback mechanism makes the process resilient but adds a crucial manual checkpoint: **any release created via fallback upload will be a draft and requires you to manually review and roll it out in the Google Play Console.**
|
||||
|
||||
Finalizing and publishing the GitHub Release and the Google Play Store submission remain **manual steps**.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before initiating the release process, ensure the following are completed:
|
||||
|
||||
1. **Main Branch Stability:** The `main` branch (or your chosen release branch) must be stable, with all features and bug fixes intended for the release merged and thoroughly tested.
|
||||
2. **Automated Testing:** All automated tests (unit, integration, UI) must be passing on the release candidate code, and CI checks on pull requests must be green.
|
||||
2. **Automated Testing:** All automated tests must be passing.
|
||||
3. **Versioning and Tagging Strategy:**
|
||||
* The primary source for the release version name in the CI workflow is the Git tag (e.g., `v1.2.3` results in version name `1.2.3`).
|
||||
* Tags **must** start with `v` and generally follow Semantic Versioning (e.g., `vX.X.X`).
|
||||
* For pre-releases, use suffixes that the workflow recognizes to set the GitHub pre-release flag and Play Store track:
|
||||
* **Internal/QA:** `vX.X.X-internal.Y` (e.g., `v1.2.3-internal.1`)
|
||||
* **Closed Alpha:** `vX.X.X-closed.Y` (e.g., `v1.2.3-closed.1`)
|
||||
* **Open Alpha/Beta:** `vX.X.X-open.Y` (e.g., `v1.2.3-open.1`)
|
||||
* **Production releases** use no suffix (e.g., `vX.X.X`). The `Y` in suffixes is an increment for iterations of the same pre-release type.
|
||||
* **Recommendation:** Before tagging, update `VERSION_NAME_BASE` in `buildSrc/src/main/kotlin/Configs.kt` to match the `X.X.X` part of your tag. This ensures consistency if the app uses this value internally. The CI workflow derives `APP_VERSION_NAME` directly from the tag and passes it to Gradle.
|
||||
4. **Final Checks:** Perform thorough manual testing of critical user flows and new features on various devices and Android versions.
|
||||
* Use the correct suffixes for the desired release phase:
|
||||
* **Internal/QA:** `vX.X.X-internal.Y`
|
||||
* **Closed Alpha:** `vX.X.X-closed.Y`
|
||||
* **Open Alpha/Beta:** `vX.X.X-open.Y`
|
||||
* **Production:** `vX.X.X` (no suffix)
|
||||
* **Recommendation:** Before tagging, update `VERSION_NAME_BASE` in `buildSrc/src/main/kotlin/Configs.kt` to match the `X.X.X` part of your tag. This ensures consistency for local development builds.
|
||||
|
||||
## Core Release Workflow: Triggering via Tag Push
|
||||
|
||||
The primary way to initiate a release is by creating and pushing a tag:
|
||||
The recommended release process follows the promotion chain.
|
||||
|
||||
1. **Ensure Local Branch is Synced:**
|
||||
1. **Start with an Internal Release:** Create and push an `-internal` tag first.
|
||||
```bash
|
||||
# Example: if releasing from main
|
||||
git checkout main
|
||||
git pull origin main
|
||||
# This build will be uploaded and rolled out on the 'internal' track
|
||||
git tag v1.2.3-internal.1
|
||||
git push origin v1.2.3-internal.1
|
||||
```
|
||||
2. **Create and Push Tag:**
|
||||
Tag the commit you intend to release (e.g., the head of `main` or a release branch).
|
||||
2. **Promote to the Next Phase:** Once the internal build is verified, create and push a tag for the next phase.
|
||||
```bash
|
||||
# Example for an open beta release
|
||||
git tag v1.2.3-open.1
|
||||
git push origin v1.2.3-open.1
|
||||
```
|
||||
Or, for a production release:
|
||||
```bash
|
||||
git tag v1.2.3
|
||||
git push origin v1.2.3
|
||||
# This will promote the v1.2.3 build from 'internal' to 'NewAlpha'
|
||||
git tag v1.2.3-closed.1
|
||||
git push origin v1.2.3-closed.1
|
||||
```
|
||||
|
||||
Pushing the tag automatically triggers the `release.yml` GitHub Action, which performs the automated steps listed in the "Note on Automation" section at the beginning of this document.
|
||||
Pushing each tag automatically triggers the `release.yml` GitHub Action.
|
||||
|
||||
## Managing Different Release Phases (Manual Steps Post-Workflow)
|
||||
|
||||
After the `release.yml` workflow completes, manual actions are needed on GitHub and in the Google Play Console.
|
||||
|
||||
### Phase 1: Internal / QA Release
|
||||
* **Tag format:** `vX.X.X-internal.Y` (e.g., `v1.2.3-internal.1`)
|
||||
* **Branching (Optional):**
|
||||
* Consider creating a `release/x.x.x` branch from `main`.
|
||||
* Update `Configs.kt` on this branch.
|
||||
* Create a draft PR from `release/x.x.x` to `main`. Tag a commit on this branch.
|
||||
* **Manual Steps Post-Workflow:**
|
||||
1. **GitHub:**
|
||||
* Navigate to the "Releases" page of the repository.
|
||||
* Find the **draft release** (e.g., "Release v1.2.3-internal.1"). It will be marked as "pre-release".
|
||||
* Verify the attached artifacts.
|
||||
* You can choose to publish this pre-release if you want it formally listed, or simply use the artifacts from the draft for internal distribution.
|
||||
2. **Google Play Console:**
|
||||
* The AAB will be uploaded as a **draft** to the **`qa` track**.
|
||||
* Review the draft release in the Play Console and promote/submit it as needed for your internal testers.
|
||||
* **Tag format:** `vX.X.X-internal.Y`
|
||||
* **Automated Action:** The AAB is **uploaded** to the `internal` track and rolled out automatically.
|
||||
* **Manual Steps:**
|
||||
1. **GitHub:** Find the **draft release**, verify artifacts, and publish it if desired.
|
||||
2. **Google Play Console:** Verify the release has been successfully rolled out to internal testers.
|
||||
|
||||
### Phase 2: Closed Alpha Release
|
||||
* **Tag format:** `vX.X.X-closed.Y` (e.g., `v1.2.3-closed.1`)
|
||||
* **Manual Steps Post-Workflow:**
|
||||
1. **GitHub:**
|
||||
* Find the **draft release**. It will be marked as "pre-release".
|
||||
* Verify artifacts. Consider publishing it as a pre-release for wider internal visibility if appropriate.
|
||||
* **Tag format:** `vX.X.X-closed.Y`
|
||||
* **Automated Action:** The workflow attempts to **promote** the build from `internal` to the `NewAlpha` track.
|
||||
* **Manual Steps:**
|
||||
1. **GitHub:** Find and publish the **draft release**.
|
||||
2. **Google Play Console:**
|
||||
* The AAB will be a **draft** on the **`newalpha` track**.
|
||||
* Review and submit it for your closed alpha testers.
|
||||
* **If promotion succeeded:** The release will be live on the `NewAlpha` track. Verify its status.
|
||||
* **If promotion failed (fallback):** The AAB will be a **draft** on the `NewAlpha` track. You must manually review and submit it for your closed alpha testers.
|
||||
|
||||
### Phase 3: Open Alpha / Beta Release
|
||||
* **Tag format:** `vX.X.X-open.Y` (e.g., `v1.2.3-open.1`)
|
||||
* **Manual Steps Post-Workflow:**
|
||||
1. **GitHub:**
|
||||
* Find the **draft release**. It will be marked as "pre-release".
|
||||
* Edit the release: Review the title (e.g., "Release v1.2.3-open.1") and the auto-generated changelog.
|
||||
* Ensure "This is a pre-release" is checked.
|
||||
* **Publish the release** on GitHub. This makes it visible to the public.
|
||||
* **Tag format:** `vX.X.X-open.Y`
|
||||
* **Automated Action:** The workflow attempts to **promote** the build from `alpha` to the `beta` track.
|
||||
* **Manual Steps:**
|
||||
1. **GitHub:** Find and publish the **draft pre-release**.
|
||||
2. **Google Play Console:**
|
||||
* The AAB will be a **draft** on the **`beta` track**.
|
||||
* Review, add release notes (can copy from GitHub changelog), and submit it for your open testers.
|
||||
* **If promotion succeeded:** The release will be live on the `beta` track. Verify its status.
|
||||
* **If promotion failed (fallback):** The AAB will be a **draft** on the `beta` track. You must manually review, add release notes, and submit it.
|
||||
|
||||
### Phase 4: Production Release
|
||||
* **Tag format:** `vX.X.X` (e.g., `v1.2.3`)
|
||||
* **Branching:**
|
||||
* Ensure all changes for the release are merged into `main`.
|
||||
* Tag the final merge commit on `main`.
|
||||
* **Manual Steps Post-Workflow:**
|
||||
1. **GitHub:**
|
||||
* Find the **draft release** (e.g., "Release v1.2.3").
|
||||
* Edit the release: Review title and changelog.
|
||||
* **Crucially, uncheck "This is a pre-release"**.
|
||||
* **Publish the release** on GitHub.
|
||||
* **Tag format:** `vX.X.X`
|
||||
* **Automated Action:** The workflow attempts to **promote** the build from `beta` to the `production` track.
|
||||
* **Manual Steps:**
|
||||
1. **GitHub:** Find the **draft release**. **Crucially, uncheck "This is a pre-release"** before publishing.
|
||||
2. **Google Play Console:**
|
||||
* The AAB will be a **draft** on the **`production` track**.
|
||||
* Review, add release notes.
|
||||
* **Start a staged rollout** or release to 100% of users.
|
||||
* **If promotion succeeded:** The release will be live on the `production` track.
|
||||
* **If promotion failed (fallback):** The AAB will be a **draft** on the `production` track. You must manually review, add release notes, and **start a staged rollout**.
|
||||
|
||||
## Iterating on Pre-Releases
|
||||
|
||||
If bugs are found in an internal, closed, or open alpha/beta:
|
||||
1. Commit fixes to your development branch (e.g., `release/x.x.x` or `main`).
|
||||
2. Create a new, incremented tag (e.g., if `v1.2.3-open.1` had bugs, use `v1.2.3-open.2`).
|
||||
3. Push the new tag.
|
||||
If bugs are found in a release:
|
||||
1. Commit fixes to your development branch.
|
||||
2. Create a new, incremented tag for the **same release phase** (e.g., if `v1.2.3-open.1` had bugs, create `v1.2.3-open.2`).
|
||||
3. Push the new tag. This will trigger a new upload to the `internal` track (if it's an internal tag) or a new promotion/fallback for other tracks.
|
||||
4. Follow the manual post-workflow steps for that release phase again.
|
||||
|
||||
## Post-Release Activities
|
||||
|
||||
1. **Monitoring:** Closely monitor app performance, crash reports, and user feedback.
|
||||
2. **Communication:** Announce the new release to the user community as appropriate.
|
||||
3. **Hotfixes (for Production Releases):**
|
||||
* If a critical bug is found in a production release:
|
||||
1. Create a hotfix branch (e.g., `hotfix/x.x.y`) from `main` (or directly from the production tag `vX.X.X`).
|
||||
2. Implement and test the fix.
|
||||
3. Update `VERSION_NAME_BASE` in `buildSrc/src/main/kotlin/Configs.kt` for the patch version (e.g., `1.2.4`).
|
||||
4. Merge the hotfix branch into `main`.
|
||||
5. Tag the merge commit on `main` with the new patch version (e.g., `v1.2.4`).
|
||||
6. Push the new tag (e.g., `git push origin v1.2.4`). This triggers the `release.yml` workflow.
|
||||
7. Follow the **Manual Steps Post-Workflow** for a **Production Release** (uncheck "pre-release" on GitHub, manage production track draft in Play Console).
|
||||
|
||||
---
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue