From f3d3b8885e6d5dd0c3b918ce2a586df0681bf6c7 Mon Sep 17 00:00:00 2001 From: Caleb Jasik Date: Tue, 4 Feb 2025 12:18:35 -0600 Subject: [PATCH 1/4] Update README with release instructions and spelling changes --- README.md | 26 +++++++++----------------- 1 file changed, 9 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 2f85f8d..85a0454 100644 --- a/README.md +++ b/README.md @@ -22,11 +22,11 @@ Run `flutter doctor` and fix everything it complains before proceeding - Copy `env.sh.example` and set it up for your machine - Ensure you have run `gomobile init` -- In Android Studio, make sure you have the current ndk installed by going to Tools -> SDK Manager, go to the SDK Tools tab, check the `Show package details` box, expand the NDK section and select `27.0.12077973` version. -- Ensure you have downloaded an ndk via android studio, this is likely not the default one and you need to check the +- In Android Studio, make sure you have the current NDK installed by going to Tools → SDK Manager, go to the SDK Tools tab, check the `Show package details` box, expand the NDK section and select `27.0.12077973` version. +- Ensure you have downloaded a NDK via android studio, this is likely not the default one, and you need to check the `Show package details` box to select the correct version. The correct version comes from the error when you try and compile - Make sure you have `gem` installed with `sudo gem install` -- If on MacOS arm, `sudo gem install ffi -- --enable-libffi-alloc` +- If on macOS arm, `sudo gem install ffi -- --enable-libffi-alloc` If you are having issues with iOS pods, try blowing it all away! `cd ios && rm -rf Pods/ Podfile.lock && pod install --repo-update` @@ -39,7 +39,11 @@ Use: dart format lib/ test/ -l 120 ``` -In Android Studio, set the line length using Preferences -> Editor -> Code Style -> Dart -> Line length, set it to 120. Enable auto-format with Preferences -> Languages & Frameworks -> Flutter -> Format code on save. +In Android Studio, set the line length using Preferences → Editor → Code Style → Dart → Line length, set it to 120. Enable auto-format with Preferences → Languages & Frameworks → Flutter → Format code on save. + +# Prerelease + +Push a git tag `v#.#.#-##`, e.g. `v0.5.2-0`, and `.github/release.yml` will build a draft release and publish it to iOS TestFlight and Android internal track. `./swift-format.sh` can be used to format Swift code in the repo. @@ -47,16 +51,4 @@ Once `swift-format` supports ignoring directories ( Archive then follow the directions to upload to the app store. If you have issues, https://flutter.dev/docs/deployment/ios#create-a-build-archive \ No newline at end of file +We manually promote a prerelease build from TestFlight and Android internal track to the public app stores, and then mark the associated draft release as published, removing the `-##` from it. \ No newline at end of file From f7d22824f8fe8ac2d5481b3977641a070a61d1e4 Mon Sep 17 00:00:00 2001 From: Caleb Jasik Date: Tue, 4 Feb 2025 12:58:34 -0600 Subject: [PATCH 2/4] Update how releasing works --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 85a0454..cf7791c 100644 --- a/README.md +++ b/README.md @@ -51,4 +51,6 @@ Once `swift-format` supports ignoring directories ( Date: Tue, 4 Feb 2025 13:31:31 -0600 Subject: [PATCH 3/4] Write out the entire release process in steps --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cf7791c..9323fda 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ In Android Studio, set the line length using Preferences → Editor → Code Sty # Prerelease -Push a git tag `v#.#.#-##`, e.g. `v0.5.2-0`, and `.github/release.yml` will build a draft release and publish it to iOS TestFlight and Android internal track. +Push a git tag `v#.#.#-##`, e.g. `v0.5.1-0`, and `.github/release.yml` will build a draft release and publish it to iOS TestFlight and Android internal track. `./swift-format.sh` can be used to format Swift code in the repo. @@ -51,6 +51,7 @@ Once `swift-format` supports ignoring directories (. \ No newline at end of file From 768266b15fba1fc487177b8047659fc48be3712e Mon Sep 17 00:00:00 2001 From: Caleb Jasik Date: Wed, 5 Feb 2025 11:35:04 -0600 Subject: [PATCH 4/4] Update casing and grammar from feedback --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9323fda..543d4ba 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,10 @@ Run `flutter doctor` and fix everything it complains before proceeding - Copy `env.sh.example` and set it up for your machine - Ensure you have run `gomobile init` - In Android Studio, make sure you have the current NDK installed by going to Tools → SDK Manager, go to the SDK Tools tab, check the `Show package details` box, expand the NDK section and select `27.0.12077973` version. -- Ensure you have downloaded a NDK via android studio, this is likely not the default one, and you need to check the +- Ensure you have downloaded an NDK via android studio, this is likely not the default one, and you need to check the `Show package details` box to select the correct version. The correct version comes from the error when you try and compile - Make sure you have `gem` installed with `sudo gem install` -- If on macOS arm, `sudo gem install ffi -- --enable-libffi-alloc` +- If on macOS arm64, `sudo gem install ffi -- --enable-libffi-alloc` If you are having issues with iOS pods, try blowing it all away! `cd ios && rm -rf Pods/ Podfile.lock && pod install --repo-update`