You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPMENT.md
+29-22Lines changed: 29 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -6,64 +6,71 @@ New releases should be created from release branches originating from the `dev`
6
6
7
7
- Make sure you've pulled all the changes from GitHub for both `dev` and `main` branches.
8
8
- Check out the `dev` branch.
9
-
- Create a new release branch with the `release-` prefix (eg, `git checkout -b release-next`).
10
-
-**IMPORTANT:** The `release-` prefix is important, as this is what triggers our GitHub CI workflow that will ultimately publish the release.
11
-
- Branches named `release-experimental` will not trigger our release workflow, as experimental releases handled differently (outlined below).
9
+
- Create a new `release-next` branch (eg, `git checkout -b release-next`).
10
+
- Technically, any `release-*next*` branch name will work as this is what triggers our GitHub CI workflow that will ultimately publish the release - but we just always use `release-next`
12
11
- Merge `main` into the release branch.
13
12
14
13
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.
15
14
16
15
### Starting a new pre-release
17
16
18
-
- Ensure you are on the new `release-*` branch.
17
+
- Ensure you are on the new `release-next` branch.
19
18
- Enter Changesets pre-release mode using the `pre` tag: `pnpm changeset pre enter pre`.
20
-
- Commit the change and push the `release-*` branch to GitHub.
19
+
- Commit the change and push the `release-next` branch to GitHub.
21
20
- 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.
22
-
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR into the `release-*` branch.
21
+
- Check out the PR branch created by changesets locally
22
+
- Review the updated `CHANGELOG.md` files in the PR locally and make any adjustments necessary, then merge the PR into the `release-next` branch.
- Once the PR is merged, the release workflow will publish the updated packages to npm.
24
+
- Once the changesets files are in good shape, merge the PR to `release-next`
25
+
- Once the PR is merged, the release workflow will publish the updated `X.Y.Z-pre.*` packages to npm.
25
26
- 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
27
- Copy the template for a new release and update the version numbers and links accordingly
27
28
- 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
29
+
- Commit these changes directly to the `release-next` branch - they will not trigger a new prerelease since they do not include a changeset
29
30
30
31
### Iterating a pre-release
31
32
32
33
You may need to make changes to a pre-release prior to publishing a final stable release. To do so:
33
34
34
-
-Make whatever changes you need.
35
+
-Branch off of `release-next` and make whatever changes you need
35
36
- Create a new changeset: `pnpm changeset`.
36
37
-**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.
37
-
- Commit the changesets and push the `release-*` branch to GitHub.
38
+
- Push your branch to GitHub and PR it to `release-next`.
39
+
- Once reviewed/approved, merge the PR to the `release-next` branch.
38
40
- Wait for the release workflow to finish and the Changesets action to open its PR that will increment all versions.
39
-
- Review the PR, make any adjustments necessary, and merge it into the `release-*` branch.
40
-
- Once the PR is merged, the release workflow will publish the updated packages to npm.
41
+
- Review the PR, make any adjustments necessary, and merge it into the `release-next` branch.
42
+
- Once the PR is merged, the release workflow will publish the updated `X.Y.Z-pre.*`packages to npm.
41
43
- Make sure you copy over the new changeset contents into stable release notes in the root `CHANGELOG.md` file in the repo
42
44
43
45
### Publishing the stable release
44
46
45
-
- Exit Changesets pre-release mode: `pnpm changeset pre exit`.
46
-
- Commit the edited pre-release file along with any unpublished changesets, and push the `release-*` branch to GitHub.
47
+
- Exit Changesets pre-release mode in the `release-next` branch: `pnpm changeset pre exit`.
48
+
- Commit the edited pre-release file along with any unpublished changesets, and push the `release-next` branch to GitHub.
47
49
- 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.
48
-
- Review the updated `CHANGELOG` files and make any adjustments necessary.
50
+
- Review the updated `CHANGELOG` files in the PR and make any adjustments necessary.
- Pull the latest `release-next` branch containing the PR you just merged
60
+
- Merge the `release-next` branch into `main`**using a non-fast-forward merge** and push it up to GitHub
61
+
-`git checkout main`
62
+
-`git merge --no-ff release-next`
63
+
-`git push origin main`
64
+
- Merge the `release-next` branch into `dev`**using a non-fast-forward merge** and push it up to GitHub
65
+
-`git checkout dev`
66
+
-`git merge --no-ff release-next`
67
+
-`git push origin dev`
62
68
- 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`
69
+
- Delete the `release-next` branch locally and on GitHub
63
70
64
71
### Hotfix releases
65
72
66
-
Hotfix releases follow the same process as standard releases above, but the `release-*` branch should be branched off latest `main` instead of `dev`. Once the stable hotfix is published, the `release-*` branch should be merged back into both `main` and `dev` just like a normal release.
73
+
Hotfix releases follow the same process as standard releases above, but the `release-next` branch should be branched off latest `main` instead of `dev`. Once the stable hotfix is published, the `release-next` branch should be merged back into both `main` and `dev` just like a normal release.
0 commit comments