wbrawner/thunderbird-android
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add information on when/how to create a maintenance branch

Browse source
This commit is contained in:
cketti 2024-04-26 18:20:27 +02:00
parent 5482edca5e
commit a563301f8b
1 changed files with 21 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
docs/RELEASING.md
View file

@ -125,29 +125,35 @@
## Release a stable version
1. If this is the first stable release in a series, create a new maintenance branch, e.g. `6.8-MAINT`
2. Switch to the appropriate maintenance branch
3. Update versionCode and versionName in `app-k9mail/build.gradle.kts` (stable releases use an even digit after the
When the team decides the `main` branch is stable enough and it's time to release a new stable version, create a new
maintenance branch (off `main`) using the desired version number with the last two digits dropped followed by `-MAINT`.
Example: `6.8-MAINT` when the first stable release is K-9 Mail 6.800.
Ideally the first stable release contains no code changes when compared to the last beta version built from `main`.
That way the new release won't contain any changes that weren't exposed to user testing in a beta version before.
1. Switch to the appropriate maintenance branch, e.g. `6.8-MAINT`
2. Update versionCode and versionName in `app-k9mail/build.gradle.kts` (stable releases use an even digit after the
dot, e.g. `5.400`, `6.603`)
4. Create change log entries in
3. Create change log entries in
- `app/ui/legacy/src/main/res/raw/changelog_master.xml`
- `app-k9mail/fastlane/metadata/android/en-US/changelogs/${versionCode}.txt`
Use past tense. Try to keep them high level. Focus on the user (experience).
5. Update the metadata link to point to K-9 Mail's data:
4. Update the metadata link to point to K-9 Mail's data:
`ln --symbolic --no-dereference --force app-metadata/com.fsck.k9 metadata`
6. Commit the changes. Message: "Version $versionName"
7. Run `./gradlew clean :app-k9mail:assembleRelease --no-build-cache --no-configuration-cache`
8. Update an existing installation to make sure the app is signed with the proper key and runs on a real device.
5. Commit the changes. Message: "Version $versionName"
6. Run `./gradlew clean :app-k9mail:assembleRelease --no-build-cache --no-configuration-cache`
7. Update an existing installation to make sure the app is signed with the proper key and runs on a real device.
```
adb install -r app-k9mail/build/outputs/apk/release/app-k9mail-release.apk
```
9. Tag as $versionName, e.g. `6.800`
10. Copy `app-k9mail/build/outputs/apk/release/app-k9mail-release.apk` as `k9-${versionName}.apk` to Google Drive (MZLA
Team > K9 > APKs)
11. Update `gh-pages` branch with the new change log. Create a new file if it's the first stable release in a series.
12. Push maintenance branch
13. Push tags
14. Push `gh-pages` branch
8. Tag as $versionName, e.g. `6.800`
9. Copy `app-k9mail/build/outputs/apk/release/app-k9mail-release.apk` as `k9-${versionName}.apk` to Google Drive (MZLA
Team > K9 > APKs)
10. Update `gh-pages` branch with the new change log. Create a new file if it's the first stable release in a series.
11. Push maintenance branch
12. Push tags
13. Push `gh-pages` branch
### Create release on GitHub