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
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
New releases should be created from release branches originating from the `dev` branch. When you are ready to begin the release process:
6
6
7
-
- Make sure you've pulled all of the changes from GitHub for both `dev` and `main` branches.
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
9
- Create a new release branch with the `release-` prefix (eg, `git checkout -b release-next`).
10
10
-**IMPORTANT:** The `release-` prefix is important, as this is what triggers our GitHub CI workflow that will ultimately publish the release.
@@ -17,7 +17,7 @@ Changesets will do most of the heavy lifting for our releases. When changes are
17
17
18
18
- Ensure you are on the new `release-*` branch.
19
19
- Enter Changesets pre-release mode using the `pre` tag: `yarn changeset pre enter pre`.
20
-
- Commit the change and push the the `release-*` branch to GitHub.
20
+
- Commit the change and push the `release-*` branch to GitHub.
21
21
- 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
22
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR into the `release-*` branch.
@@ -30,27 +30,27 @@ You may need to make changes to a pre-release prior to publishing a final stable
30
30
- Make whatever changes you need.
31
31
- Create a new changeset: `yarn changeset`.
32
32
-**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.
33
-
- Commit the changesets and push the the `release-*` branch to GitHub.
33
+
- Commit the changesets and push the `release-*` branch to GitHub.
34
34
- Wait for the release workflow to finish and the Changesets action to open its PR that will increment all versions.
35
35
- Review the PR, make any adjustments necessary, and merge it into the `release-*` branch.
36
36
- Once the PR is merged, the release workflow will publish the updated packages to npm.
37
37
38
38
### Publishing the stable release
39
39
40
40
- Exit Changesets pre-release mode: `yarn changeset pre exit`.
41
-
- Commit the edited pre-release file along with any unpublished changesets, and push the the `release-*` branch to GitHub.
41
+
- Commit the edited pre-release file along with any unpublished changesets, and push the `release-*` branch to GitHub.
42
42
- 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.
43
43
- Review the updated `CHANGELOG` files and make any adjustments necessary.
44
44
- We should remove the changelogs for all pre-releases ahead of publishing the stable version.
45
45
-[TODO: We should automate this]
46
-
- Prepare the github release notes
46
+
- Prepare the GitHub release notes
47
47
- Copy the relevant changelog entries from all packages into the Release Notes and adjust accordingly, matching the format used by prior releases
48
48
- Merge the PR into the `release-*` branch.
49
49
- Once the PR is merged, the release workflow will publish the updated packages to npm.
50
50
- Once the release is published:
51
51
- merge the `release-*` branch into `main` and push it up to GitHub
52
52
- merge the `release-*` branch into `dev` and push it up to GitHub
53
-
- Convert the `[email protected]` tag to a Release on Github with the name `v6.x.y`
53
+
- Convert the `[email protected]` tag to a Release on GitHub with the name `v6.x.y`
We recommend all web projects use [`createBrowserRouter`][createbrowserrouter].
59
59
60
-
It uses the full URL instead of the hash urls (`#this/stuff`) common in web apps before `window.pushState` was standardized. Full URLs are better for SEO, better for server rendering, and are just more compatible with the rest of the web platform.
60
+
It uses the full URL instead of the hash urls (`#this/stuff`) common in web apps before `history.pushState` was standardized. Full URLs are better for SEO, better for server rendering, and are just more compatible with the rest of the web platform.
61
61
62
62
If you're hosting your app on a static file server, you'll need to configure it to send all requests to your `index.html` to avoid getting 404s.
0 commit comments