Update README with release instructions and spelling changes #247
Conversation
README.md
Outdated
| Update a draft release on GitHub to not contain the `-##`, after which `.github/release.yml` will build the release and publish it to the iOS App Store and Android Google Play Store. |
There was a problem hiding this comment.
Are there additional steps that have to happen? I'm unaware.
There was a problem hiding this comment.
When you publish a draft you are removing the build number but that's not actually generating new artifacts. We are choosing the build that a human promoted to production in the app stores and marking it as the one we released in github.
There was a problem hiding this comment.
Updated to reflect that.
jasikpark
force-pushed
the
release-spellfix-readme
branch
2 times, most recently
from
fd6e62e to
0fa61a0
Compare
README.md
Outdated
| 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. |
There was a problem hiding this comment.
removing the
-##from it.
To be specific: we are creating a new tag in the format v#.#.# by removing the -##, updating the title of the release to Release v#.#.#, and ideally we would also populate the changes in this release taken from the CHANGELOG.md
For the CHANGELOG.md, we lost our flow there and would be great to get back into the habit of updating it.
There was a problem hiding this comment.
This is all done by editing the draft release in GitHub ui and not by publishing a new tag to the same commit, right?
There was a problem hiding this comment.
Yes, all done in the UI. We should also delete the other draft builds that came along the way to the final released build
README.md
Outdated
| - 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 |
There was a problem hiding this comment.
Nit: This should in fact be an NDK, because N is a vowel sound when pronounced as a single letter.
README.md
Outdated
| `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` |
There was a problem hiding this comment.
If we're being picky about capitalization, shouldn't it also be ARM?
There was a problem hiding this comment.
https://developer.apple.com/documentation/apple-silicon/building-a-universal-macos-binary
Going w/ arm64 from apple's docs, if that sounds fine.
jasikpark
force-pushed
the
release-spellfix-readme
branch
from
adcc795 to
202b33c
Compare
jasikpark
force-pushed
the
release-spellfix-readme
branch
from
202b33c to
768266b
Compare
This adds updated instructions for how to deploy and prerelease to Testflight and Android internal track, how to deploy a public release, and some capitalization and formatting changes.