From 7666c4e053c52cd2833e5debecca2e99ef90ac04 Mon Sep 17 00:00:00 2001 From: Manav Date: Sat, 28 Jan 2023 15:31:24 +0530 Subject: [PATCH] Document automated releases --- README.md | 3 +++ RELEASES.md | 12 ++++++++++++ 2 files changed, 15 insertions(+) create mode 100644 RELEASES.md diff --git a/README.md b/README.md index e9937060c..fe0c7321c 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,9 @@ tokens has been documented [here](architecture/README.md). 4. For Android, run `flutter build apk --release --flavor independent` 5. For iOS, run `flutter build ios` +For maintainers, there is [additional documentation](RELEASES.md) on +automatically publishing the main branch to App store, Play store and GitHub +releases. ## 🙋‍♂️ Support diff --git a/RELEASES.md b/RELEASES.md new file mode 100644 index 000000000..2064319bc --- /dev/null +++ b/RELEASES.md @@ -0,0 +1,12 @@ +# Releases + +1. Create a PR to bump up the version number in `pubspec.yaml`. + +2. Once that is merged, tag main. This'll trigger the + [workflow](.github/workflows/ci.yml) to (a) create a new GitHub release with + the independently distributed APK, and (b) build and upload a release to + Google Play. + +3. Xcode Cloud has already been configured and will automatically build and + release to TestFlight when step 1 was merged to main (you can see logs under + the PR checks).