Skip to content

Commit 5f34a96

Browse files
committed
Update DEVELOPMENT.md
1 parent a0c3e34 commit 5f34a96

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

DEVELOPMENT.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,17 @@ Changesets will do most of the heavy lifting for our releases. When changes are
2222
- `git commit -a -m "Enter prerelease mode"`
2323
- `git push --set-upstream origin release-next`
2424
- Wait for the release workflow to finish - the Changesets action will open a PR that will increment all versions and generate the changelogs
25-
- Check out the PR branch created by changesets locally
26-
- _Optional:_ Review the updated `CHANGELOG.md` files in the PR locally and make any adjustments necessary, then merge the PR into the `release-next` branch.
27-
- `find packages -name 'CHANGELOG.md' -mindepth 2 -maxdepth 2 -exec code {} \;`
28-
- Usually for prereleases there's not much to change here because the prerelease sections will be deleted prior to the final stable release anyway
25+
- If you need/want to make any changes to the `CHANGELOG.md` files, you can do so and commit directly to the PR branch
26+
- This is usually not required for prereleases
2927
- Once the changesets files are in good shape, merge the PR to `release-next`
3028
- Once the PR is merged, the release workflow will publish the updated `X.Y.Z-pre.*` packages to npm
29+
30+
### Prepare the draft release notes
31+
3132
- At this point, you can begin crafting the release notes for the eventual stable release in the root `CHANGELOG.md` file in the repo
3233
- Copy the template for a new release and update the version numbers and links accordingly
3334
- Copy the relevant changelog entries from all packages into the release notes and adjust accordingly
35+
- `find packages -name 'CHANGELOG.md' -mindepth 2 -maxdepth 2 -exec code {} \;`
3436
- Commit these changes directly to the `release-next` branch - they will not trigger a new prerelease since they do not include a changeset
3537

3638
### Iterating a pre-release
@@ -96,15 +98,24 @@ After the `6.25.0` release, we branched off a `v6` branch for continued `6.x` wo
9698
- Once the stable release is out:
9799
- Merge `release-v6` back to `v6` with a **Normal Merge**
98100
- **Do not** merge `release-v6` to `main`
99-
- Copy the updated changelog entry for the `6.X.Y` version to `main`
101+
- Copy the updated root `CHANGELOG.md` entry for the `6.X.Y` release to `main` and `dev`
102+
- `git checkout main`
103+
- `git diff [email protected]@6.X.Y -- "***CHANGELOG.md" > ./docs.patch`
104+
- `git apply ./docs.patch`
105+
- `git checkout dev`
106+
- `git apply ./docs.patch`
107+
- `rm ./docs.patch`
100108
- Copy the docs changes to `main` so they show up on the live docs site for v6
101109
- `git checkout main`
102110
- `git diff [email protected]@6.X.Y docs/ > ./docs.patch`
103111
- `git apply ./docs.patch`
104-
- The _code_ changes should already be in the `dev` branch but confirm that the commits in this release are all included in `dev` already:
105-
- I.e., https://github.com/remix-run/react-router/compare/[email protected]@6.26.2
106-
- If one or more are not, then you can manually bring them over by cherry-picking the commit (or re-doing the work)
107-
- You should not include a changelog in your commit to `dev`
112+
- `rm ./docs.patch`
113+
- The _code_ changes should already be in the `dev` branch
114+
- This should have happened at the time the v6 change was made (except for changes such as deprecation warnings)
115+
- Confirm that the commits in this release are all included in `dev` already:
116+
- I.e., https://github.com/remix-run/react-router/compare/[email protected]@6.26.2
117+
- If one or more are not, then you can manually bring them over by cherry-picking the commit (or re-doing the work)
118+
- You should not include a changelog in your commit to `dev`
108119
- Copy the updated changelogs from `release-next` over to `dev` so the changelogs continue to reflect this new 6x release into the v7 releases
109120

110121
### Notes on 7.0.0-pre.N released during the v7 prerelease

0 commit comments

Comments
 (0)