|
| 1 | +# Release Process (Android) |
| 2 | + |
| 3 | +This document standardizes how we cut beta and stable releases for Fearless Android. |
| 4 | + |
| 5 | +## Versioning & Branching |
| 6 | + |
| 7 | +- Versioning: semantic with optional pre-release suffix. |
| 8 | + - Beta: `4.2.0-beta.1`, Stable: `4.2.0`. |
| 9 | + - Update in root `build.gradle`: `versionName`, increment `versionCode`. |
| 10 | +- Branching: |
| 11 | + - Work branch: feature/stabilization or release/docs-x.y.z |
| 12 | + - Open a PR to `develop` (or the release branch if used), then merge to `master` when promoted. |
| 13 | +- Tags (signed): |
| 14 | + - Beta: `git tag -s 4.2.0-beta.1 -m "fearless-Android 4.2.0-beta.1"` |
| 15 | + - Stable: `git tag -s 4.2.0 -m "fearless-Android 4.2.0"` |
| 16 | + |
| 17 | +## Preconditions |
| 18 | + |
| 19 | +- Toolchain: JDK 21, Android SDK 35 + build-tools 35.0.0, NDK r28 (and legacy r25 if needed), Rust toolchain. |
| 20 | +- Secrets: configured via env or `local.properties` (see README / docs samples). |
| 21 | +- Optional alignment overrides (first run mirrors): `TYPES_URL_OVERRIDE`, `DEFAULT_V13_TYPES_URL_OVERRIDE`, `CHAINS_URL_OVERRIDE`. |
| 22 | + |
| 23 | +## Pre‑Release Checklist |
| 24 | + |
| 25 | +- Alignment print: |
| 26 | + - `./gradlew printPolkadotSdkAlignment` |
| 27 | + - Confirm effective URLs and shared_features pin (or "(not pinned)"). |
| 28 | +- Static analysis: |
| 29 | + - `./gradlew detektAll` |
| 30 | +- Unit tests + coverage: |
| 31 | + - `./gradlew runTest` |
| 32 | + - Inspect `*/build/reports/tests/testDebugUnitTest/index.html`. |
| 33 | +- Lint (app): |
| 34 | + - `./gradlew :app:lint` |
| 35 | +- Full sequence (fast‑fail ordered): |
| 36 | + - `./gradlew postMergeVerify` |
| 37 | +- Update docs: |
| 38 | + - `CHANGELOG.md` with a concise, user‑facing summary. |
| 39 | + - `docs/releases/<version>.md` with scope, risks, test matrix, rollout. |
| 40 | + |
| 41 | +## Beta Release |
| 42 | + |
| 43 | +- Bump version to `x.y.z-beta.n`. |
| 44 | +- Build: |
| 45 | + - `./gradlew :app:assembleRelease` |
| 46 | +- Upload (CI recommended): |
| 47 | + - Use Gradle Play Publisher or your CI step to release to an internal/closed track. |
| 48 | +- Monitor: |
| 49 | + - Crash/ANR, Play pre‑launch report, QA regression, dapp sessions (Reown). |
| 50 | +- Exit criteria: |
| 51 | + - Crash‑free ≥ 99.5%, no P0/P1 blocking issues in core flows. |
| 52 | + |
| 53 | +## Stable Release |
| 54 | + |
| 55 | +- Bump version to `x.y.z` (remove `-beta.*`). |
| 56 | +- Tag and push (signed): |
| 57 | + - `git tag -s x.y.z -m "fearless-Android x.y.z" && git push origin x.y.z` |
| 58 | +- Staged rollout: |
| 59 | + - 10% → 25% → 50% → 100%, monitoring crash‑free and error rates. |
| 60 | +- Post‑release: |
| 61 | + - Create `x.y.z` GitHub Release notes (paste from changelog). |
| 62 | + - Consider `x.y.(z+1)` patch branch if hotfixes expected. |
| 63 | + |
| 64 | +## CI/CD Integration |
| 65 | + |
| 66 | +- GitHub Actions: |
| 67 | + - Runs detekt, tests, lint, assemble. Prints Polkadot SDK alignment early. |
| 68 | +- Jenkins (PRs): |
| 69 | + - `testCmd: runTest` for unit tests; use `postMergeVerify` on demand for full checks. |
| 70 | +- Stability guards: |
| 71 | + - Ordered tasks to avoid DataBinding races; Gradle parallel disabled in Jenkins. |
| 72 | + |
| 73 | +## Store Submission Notes |
| 74 | + |
| 75 | +- Play track: Beta to internal/closed; stable to production (staged). |
| 76 | +- Signing: CI or Play App Signing as configured. |
| 77 | +- Release text: summarized from `CHANGELOG.md` and `docs/releases/<version>.md`. |
| 78 | + |
| 79 | +## Rollback |
| 80 | + |
| 81 | +- Halt staged rollout in Play if metrics degrade. |
| 82 | +- Revert tag and bump hotfix `x.y.(z+1)` if needed. |
| 83 | +- Communicate in PR and `docs/status.md`. |
| 84 | + |
| 85 | +## PR Template (Release Docs or Bump) |
| 86 | + |
| 87 | +- Use the repository PR checklist; include: |
| 88 | + - Version changes, tags planned. |
| 89 | + - Links to release docs and changelog. |
| 90 | + - Evidence of detekt/tests/lint runs (local or CI). |
| 91 | + |
0 commit comments