Skip to content

Commit c4fa61a

Browse files
committed
Merge branch 'release-next' into dev
2 parents 167699a + c312eaa commit c4fa61a

31 files changed

+359
-102
lines changed

.changeset/fluffy-forks-attack.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changeset/long-jokes-wait.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changeset/nasty-carrots-breathe.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changeset/quick-yaks-join.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changeset/witty-melons-sip.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

DEVELOPMENT.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,50 @@
44

55
New releases should be created from release branches originating from the `dev` branch. When you are ready to begin the release process:
66

7-
- Make sure you've pulled all of the changes from GitHub for both `dev` and `main` branches
8-
- Check out the `dev` branch
9-
- Create a new release branch with the `release-` prefix (eg, `git checkout -b release-v6.5.1`)
7+
- Make sure you've pulled all of the changes from GitHub for both `dev` and `main` branches.
8+
- Check out the `dev` branch.
9+
- Create a new release branch with the `release-` prefix (eg, `git checkout -b release-next`).
1010
- **IMPORTANT:** The `release-` prefix is important, as this is what triggers our GitHub CI workflow that will ultimately publish the release.
11-
- Merge `main` into the release branch
11+
- Branches named `release-experimental` will not trigger our release workflow, as experimental releases handled differently (outlined below).
12+
- Merge `main` into the release branch.
1213

1314
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.
1415

1516
### Starting a new pre-release
1617

17-
- Ensure you are on the new `release-*` branch
18-
- Enter Changesets pre-release mode using the `pre` tag: `yarn changeset pre enter pre`
19-
- 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
20-
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR
21-
- Once the PR is merged, the release workflow will publish the updated packages to npm
18+
- Ensure you are on the new `release-*` branch.
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.
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+
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR into the `release-*` branch.
23+
- `find packages -name 'CHANGELOG.md' -mindepth 2 -maxdepth 2 -exec code {} \;`
24+
- Once the PR is merged, the release workflow will publish the updated packages to npm.
2225

2326
### Iterating a pre-release
2427

2528
You may need to make changes to a pre-release prior to publishing a final stable release. To do so:
2629

27-
- Make whatever changes you need
28-
- Create a new changeset: `yarn changeset`
30+
- Make whatever changes you need.
31+
- Create a new changeset: `yarn changeset`.
2932
- **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.
30-
- 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
31-
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR
32-
- Once the PR is merged, the release workflow will publish the updated packages to npm
33+
- Commit the changesets and push the the `release-*` branch to GitHub.
34+
- Wait for the release workflow to finish and the Changesets action to open its PR that will increment all versions.
35+
- Review the PR, make any adjustments necessary, and merge it into the `release-*` branch.
36+
- Once the PR is merged, the release workflow will publish the updated packages to npm.
3337

3438
### Publishing the stable release
3539

36-
- Exit Changesets pre-release mode: `yarn changeset pre exit`
37-
- Commit the unpublished 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 to stable
38-
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR
39-
- Once the PR is merged, the release workflow will publish the updated packages to npm
40+
- Exit Changesets pre-release mode: `yarn changeset pre exit`.
41+
- Commit the deleted pre-release file along with any unpublished changesets, and push the the `release-*` branch to GitHub.
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+
- Review the updated `CHANGELOG` files and make any adjustments necessary.
44+
- We should remove the changelogs for all pre-releases ahead of publishing the stable version.
45+
- [TODO: We should automate this]
46+
- Merge the PR into the `release-*` branch.
47+
- Once the PR is merged, the release workflow will publish the updated packages to npm.
4048
- Once the release is published:
41-
- merge the `release-*` branch into `main` and push it up to github
42-
- merge the `release-*` branch into `dev` and push it up to github
49+
- merge the `release-*` branch into `main` and push it up to GitHub
50+
- merge the `release-*` branch into `dev` and push it up to GitHub
4351
- Convert the `[email protected]` tag to a Release on Github with the name `v6.x.y`
4452
- Copy the relevant changelog entries from all packages into the Release Notes and adjust accordingly, matching the format used by prior releases
4553

contributors.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
- 0xEddie
12
- abdallah-nour
23
- abhi-kr-2100
34
- AchThomas
@@ -9,6 +10,7 @@
910
- alany411
1011
- alexlbr
1112
- AmRo045
13+
- amsal
1214
- andreiduca
1315
- arnassavickas
1416
- aroyan
@@ -70,6 +72,7 @@
7072
- hyesungoh
7173
- ianflynnwork
7274
- IbraRouisDev
75+
- igniscyan
7376
- infoxicator
7477
- IsaiStormBlesed
7578
- Isammoc
@@ -91,6 +94,7 @@
9194
- jrakotoharisoa
9295
- kachun333
9396
- kantuni
97+
- kark
9498
- KAROTT7
9599
- kddnewton
96100
- kentcdodds
@@ -133,6 +137,7 @@
133137
- omar-moquete
134138
- p13i
135139
- parched
140+
- parveen232
136141
- paulsmithkc
137142
- pavsoldatov
138143
- pcattori
@@ -159,16 +164,19 @@
159164
- tanayv
160165
- theostavrides
161166
- thisiskartik
167+
- thomasverleye
162168
- ThornWu
163169
- timdorr
164170
- TkDodo
165171
- tkindy
166172
- tlinhart
167173
- tom-sherman
168174
- triangularcube
175+
- trungpv1601
169176
- turansky
170177
- tyankatsu0105
171178
- underager
179+
- ValiantCat
172180
- vijaypushkin
173181
- vikingviolinist
174182
- vishwast03
@@ -177,6 +185,7 @@
177185
- williamsdyyz
178186
- xavier-lc
179187
- xcsnowcity
188+
- yionr
180189
- yuleicul
181190
- zheng-chuang
182191
- nnhjs

docs/fetch/redirect.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ const loader = async () => {
1515
if (!user) {
1616
return redirect("/login");
1717
}
18+
return null;
1819
};
1920
```
2021

docs/guides/deferred.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Let's take a dive into how to accomplish this.
6565

6666
Start by adding `<Await />` for your slow data requests where you'd rather render a fallback UI. Let's do that for our example above:
6767

68-
```jsx lines=[3,9,13,24-40]
68+
```jsx lines=[3,9,13-15,24-40]
6969
import {
7070
Await,
7171
defer,

docs/route/route.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ You can make a route segment optional by adding a `?` to the end of the segment.
149149
path="/:lang?/categories"
150150
// the matching param might be available to the loader
151151
loader={({ params }) => {
152-
console.log(params["*"]); // "one/two"
152+
console.log(params["lang"]); // "en"
153153
}}
154154
// and the action
155155
action={({ params }) => {}}
@@ -327,7 +327,6 @@ Please see the [errorElement][errorelement] documentation for more details.
327327

328328
Any application-specific data. Please see the [useMatches][usematches] documentation for details and examples.
329329

330-
[outlet]: ./outlet
331330
[remix]: https://remix.run
332331
[indexroute]: ../start/concepts#index-routes
333332
[outlet]: ../components/outlet

0 commit comments

Comments
 (0)