This repository has been archived by the owner on Jun 17, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 404
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document current release process (#165)
* [vscode] Import style rule * [README] Import first pass at high-level description of current process * [docs] Import branch-strategy doc * Address PR feedback Co-Authored-By: Lorenzo Sciandra <lorenzo.sciandra@gmail.com> * [docs] First pass at detailed release process * [docs] Add release process in more detail * [docs] Remove newlines within paragraphs * [docs] Prettier * [vscode] Remove settings * [docs] No RCs are made for patch versions * [docs] Finish first pass at release-process doc * [docs] Simply wording * [docs] First pass at publish doc * [docs] Finish publish-release doc * [docs] Bring back README intro * [docs] Add @lucasbento as upgrade-helper point person * [docs] Address PR feedback Co-authored-by: Lorenzo Sciandra <lorenzo.sciandra@gmail.com>
- Loading branch information
Showing
7 changed files
with
261 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Generate changelog | ||
|
|
||
| Point people: [@alloy](https://github.com/alloy), [@turnrye](https://github.com/turnrye) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| # Publish a release | ||
|
|
||
| _Point people: [@alloy](https://github.com/alloy), [@grabbou](https://github.com/grabbou), [@kelset](https://github.com/kelset)_ | ||
|
|
||
| ℹ️ _Note that some of these steps rely on Xcode and thus the usage of a Mac._ | ||
|
|
||
| 1. First cleanup your environment: | ||
|
|
||
| - Remove the `RNTester` and `RNTestProject` apps from both the iOS simulator and Android emulator. | ||
| - Then remove any build-artifacts: | ||
| ```bash | ||
| rm react-native-*.tgz | ||
| rm -rf node_modules | ||
| ./gradlew clean | ||
| ./gradlew cleanBuildCache | ||
| rm -rf /tmp/RNTestProject | ||
| pushd RNTester | ||
| rm -rf Pods | ||
| xcodebuild -workspace RNTesterPods.xcworkspace -scheme RNTester clean | ||
| popd | ||
| ``` | ||
|
|
||
| 1. Ensure you have everything installed that’s required to cut a release: | ||
|
|
||
| - The Android toolchain, as per the “Android development environment” section of [the react-native setup guide](https://reactnative.dev/docs/getting-started). | ||
| - Download [Android NDK 21](https://developer.android.com/ndk/downloads) and place it at `~/Library/Android/android-ndk-r21`, then add the following environment setup: | ||
| ```bash | ||
| export ANDROID_NDK_HOME=$HOME/Library/Android/android-ndk-r21 | ||
| ``` | ||
| - Latest iOS | ||
| - Latest yarn | ||
| - Latest CocoaPods | ||
| - Install dependencies: | ||
| ```bash | ||
| yarn install | ||
| pushd RNTester | ||
| pod install --repo-update | ||
| popd | ||
| ``` | ||
|
|
||
| 1. Run the script that will guide you through manually testing whether `RNTester` and new applications work on both iOS and Android: | ||
|
|
||
| ```bash | ||
| ./scripts/test-manual-e2e.sh | ||
| ``` | ||
|
|
||
| 1. In case your local branch has changes that do not yet exist on the remote, push them now and make not of possible deterioration of CI status. | ||
|
|
||
| 1. Bump the version numbers, which should also push the change to the remote: | ||
|
|
||
| ```bash | ||
| ./scripts/bump-oss-version.js [VERSION] | ||
| ``` | ||
|
|
||
| 1. Pushing the changed version numbers will eventually kickoff the `publish_npm_package` workflow on CI, keep an eye on it. | ||
|
|
||
| ⚠️ Currently publishing fails due to SSH not being setup to accept github.com automatically. To workaround this: | ||
|
|
||
| - Re-run the failed build with SSH enabled. | ||
| - Look for the `Enable SSH` step and expand it to reveal details on how to connect to the VM through SSH. | ||
| - Connect through SSH as per the given instructions. | ||
| - Wait for the CI workflow to reach the `node ./scripts/publish-npm.js` step, then kill the process from your SSH session: | ||
| ```bash | ||
| ps -ax | grep 'node ./scripts/publish-npm.js' | ||
| kill [PID] | ||
| ``` | ||
| - Restart the publish script interactively and type “yes” when asked to accept the fingerprint of github.com: | ||
| ```bash | ||
| node ./scripts/publish-npm.js | ||
| ``` | ||
| - Once finished, quit the SSH session: | ||
| ```bash | ||
| exit | ||
| ``` | ||
|
|
||
| 1. Test that npmjs.com returns the correct results: | ||
|
|
||
| ```bash | ||
| npm view react-native | ||
| ``` | ||
|
|
||
| 1. Once more test that creating a new application works as expected: | ||
|
|
||
| ```bash | ||
| npx react-native init TestRelease --version [VERSION] | ||
| ``` | ||
|
|
||
| 1. Communicate the release as per the instructions in the release-process doc. [⇒](./release-process.md) |
Oops, something went wrong.