Update DEVELOPMENT.md

remix-run · Oct 12, 2023 · 56767f1 · 56767f1
1 parent 28d43f8
commit 56767f1
Showing 1 changed file with 36 additions and 31 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -35,50 +35,54 @@ yarn test react --watch
 
 New releases should be created from release branches originating from the `dev` branch. When you are ready to begin the release process:
 
-- Make sure you've pulled all of the changes from GitHub for both `dev` and `main` branches.
-- Check out the `dev` branch.
-- Create a new release branch with the `release-` prefix (eg, `git checkout -b release-next`).
-  - **IMPORTANT:** The `release-` prefix is important, as this is what triggers our GitHub CI workflow that will ultimately publish the release.
-  - Branches named `release-experimental` will not trigger our release workflow, as experimental releases handled differently (outlined below).
-- Merge `main` into the release branch.
+- Make sure you've pulled all of the changes from GitHub for both `dev` and `main` branches
+- Check out the `dev` branch
+- If needed, bump the dependencies to the correct React Router release
+  - `./scripts/bump-router-versions.sh [pre|latest]`
+- Create a new release branch with the `release-` prefix
+  - `git checkout -b release-next`
+  - **IMPORTANT:** The `release-` prefix is important, as this is what triggers our GitHub CI workflow that will ultimately publish the release
+  - Branches named `release-experimental` will not trigger our release workflow, as experimental releases handled differently (outlined below)
+- Merge `main` into the release branch
 
 Changesets will do most of the heavy lifting for our releases. When changes are made to the codebase, an accompanying changeset file should be included to document the change. Those files will dictate how Changesets will version our packages and what shows up in the changelogs.
 
 ### Starting a new pre-release
 
-- Ensure you are on the new `release-*` branch.
-- Enter Changesets pre-release mode using the `pre` tag: `yarn changeset pre enter pre`.
-- Commit the change and push the `release-*` branch to GitHub.
-- Wait for the release workflow to finish. The Changesets action in the workflow will open a PR that will increment all versions and generate the changelogs.
-- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR into the `release-*` branch.
+- Ensure you are on the new `release-*` branch
+- Enter Changesets pre-release mode using the `pre` tag: `yarn changeset pre enter pre`
+- Commit the change and push the `release-*` branch to GitHub
+- Wait for the release workflow to finish - the Changesets action in the workflow will open a PR that will increment all versions and generate the changelogs
+- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR into the `release-*` branch
   - `find packages -name 'CHANGELOG.md' -mindepth 2 -maxdepth 2 -exec code {} \;`
-- Once the PR is merged, the release workflow will publish the updated packages to npm.
+- Once the PR is merged, the release workflow will publish the updated packages to npm
 
 ### Iterating a pre-release
 
 You may need to make changes to a pre-release prior to publishing a final stable release. To do so:
 
-- Make whatever changes you need.
-- Create a new changeset: `yarn changeset`.
-  - **IMPORTANT:** This is required even if you ultimately don't want to include these changes in the logs. Remember, changelogs can be edited prior to publishing, but the Changeset version script needs to see new changesets in order to create a new version.
-- Commit the changesets and push the the `release-*` branch to GitHub.
-- Wait for the release workflow to finish and the Changesets action to open its PR that will increment all versions.
-- Review the PR, make any adjustments necessary, and merge it into the `release-*` branch.
-- Once the PR is merged, the release workflow will publish the updated packages to npm.
+- Make whatever changes you need
+- Create a new changeset: `yarn changeset`
+  - **IMPORTANT:** This is required even if you ultimately don't want to include these changes in the logs
+  - Remember, changelogs can be edited prior to publishing, but the Changeset version script needs to see new changesets in order to create a new version
+- Commit the changesets and push the the `release-*` branch to GitHub
+- Wait for the release workflow to finish and the Changesets action to open its PR that will increment all versions
+- Review the PR, make any adjustments necessary, and merge it into the `release-*` branch
+- Once the PR is merged, the release workflow will publish the updated packages to npm
 
 ### Publishing the stable release
 
-- Exit Changesets pre-release mode: `yarn changeset pre exit`.
-- Commit the edited `pre.json` file along with any unpublished changesets, and push the `release-*` branch to GitHub.
-- Wait for the release workflow to finish. The Changesets action in the workflow will open a PR that will increment all versions and generate the changelogs for the stable release.
-- Review the updated `CHANGELOG` files and make any adjustments necessary.
+- Exit Changesets pre-release mode: `yarn changeset pre exit`
+- Commit the edited `pre.json` file along with any unpublished changesets, and push the `release-*` branch to GitHub
+- Wait for the release workflow to finish - the Changesets action in the workflow will open a PR that will increment all versions and generate the changelogs for the stable release
+- Review the updated `CHANGELOG` files and make any adjustments necessary
   - `find packages -name 'CHANGELOG.md' -mindepth 2 -maxdepth 2 -exec code {} \;`
-  - We should remove the changelogs for all pre-releases ahead of publishing the stable version.
+  - We should remove the changelogs for all pre-releases ahead of publishing the stable version
   - [TODO: We should automate this]
 - Prepare the github release notes
   - Copy the relevant changelog entries from all packages into the Release Notes and adjust accordingly, matching the format used by prior releases
-- Merge the PR into the `release-*` branch.
-- Once the PR is merged, the release workflow will publish the updated packages to npm.
+- Merge the PR into the `release-*` branch
+- Once the PR is merged, the release workflow will publish the updated packages to npm
 - Once the release is published:
   - Pull the latest `release-*` branch containing the PR you just merged
   - Merge the `release-*` branch into `main` **using a non-fast-forward merge** and push it up to GitHub
@@ -95,11 +99,12 @@ Hotfix releases follow the same process as standard releases above, but the `rel
 
 Experimental releases do not need to be branched off of `dev`. Experimental releases can be branched from anywhere as they are not intended for general use.
 
-- Create a new branch for the release: `git checkout -b release-experimental`.
-- Make whatever changes you need and commit them: `git add . && git commit "experimental changes!"`.
-- Update version numbers and create a release tag: `yarn version:experimental`.
-- Push to GitHub: `git push origin --follow-tags`.
-- Create a new release for the tag on GitHub to trigger the CI workflow that will publish the release to npm. Make sure you check the "prerelease" checkbox so it is not mistaken for a stable release.
+- Create a new branch for the release: `git checkout -b release-experimental`
+- Make whatever changes you need and commit them: `git add . && git commit "experimental changes!"`
+- Update version numbers and create a release tag: `yarn version:experimental`
+- Push to GitHub: `git push origin --follow-tags`
+- Create a new release for the tag on GitHub to trigger the CI workflow that will publish the release to npm
+  - Make sure you check the "prerelease" checkbox so it is not mistaken for a stable release
 
 ## Local Development Tips and Tricks