Skip to content

Commit 56e0022

Browse files
committed
Update release process to reflect new release notes doc
1 parent d94d616 commit 56e0022

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

DEVELOPMENT.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ Changesets will do most of the heavy lifting for our releases. When changes are
2222
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR into the `release-*` branch.
2323
- `find packages -name 'CHANGELOG.md' -mindepth 2 -maxdepth 2 -exec code {} \;`
2424
- Once the PR is merged, the release workflow will publish the updated packages to npm.
25+
- At this point, you can begin crafting the release notes for the eventual stable release in the root `CHANGELOG.md` file in the repo
26+
- Copy the template for a new release and update the version numbers and links accordingly
27+
- Copy the relevant changelog entries from all packages into the release notes and adjust accordingly
28+
- Commit these changes directly to the `release-*` branch - they will not trigger a new prerelease since they do not include a changeset
2529

2630
### Iterating a pre-release
2731

@@ -34,6 +38,7 @@ You may need to make changes to a pre-release prior to publishing a final stable
3438
- Wait for the release workflow to finish and the Changesets action to open its PR that will increment all versions.
3539
- Review the PR, make any adjustments necessary, and merge it into the `release-*` branch.
3640
- Once the PR is merged, the release workflow will publish the updated packages to npm.
41+
- Make sure you copy over the new changeset contents into stable release notes in the root `CHANGELOG.md` file in the repo
3742

3843
### Publishing the stable release
3944

@@ -42,10 +47,11 @@ You may need to make changes to a pre-release prior to publishing a final stable
4247
- 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.
4348
- Review the updated `CHANGELOG` files and make any adjustments necessary.
4449
- `find packages -name 'CHANGELOG.md' -mindepth 2 -maxdepth 2 -exec code {} \;`
45-
- We should remove the changelogs for all pre-releases ahead of publishing the stable version.
50+
- Remove the changelogs for all pre-releases
4651
- [TODO: We should automate this]
47-
- Prepare the GitHub release notes
48-
- Copy the relevant changelog entries from all packages into the Release Notes and adjust accordingly, matching the format used by prior releases
52+
- Finalize the release notes
53+
- This should already be in pretty good shape in the root `CHANGELOG.md` file in the repo
54+
- Do a quick double check that all iterated prerelease changesets got copied over
4955
- Merge the PR into the `release-*` branch.
5056
- Once the PR is merged, the release workflow will publish the updated packages to npm.
5157
- Once the release is published:
@@ -54,7 +60,7 @@ You may need to make changes to a pre-release prior to publishing a final stable
5460
- `git checkout main; git merge --no-ff release-next`
5561
- Merge the `release-*` branch into `dev` **using a non-fast-forward merge** and push it up to GitHub
5662
- `git checkout dev; git merge --no-ff release-next`
57-
- Convert the `[email protected]` tag to a Release on GitHub with the name `v6.x.y`
63+
- Convert the `[email protected]` tag to a Release on GitHub with the name `v6.x.y` and add a deep-link to the release heading in `CHANGELOG.md`
5864

5965
### Hotfix releases
6066

0 commit comments

Comments
 (0)