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: CHANGELOG.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,12 @@
2
2
3
3
# Remix Releases
4
4
5
-
This page lists all releases/release notes for Remix back to `v2.0.0`. For releases prior to v2, please refer to the [Github Releases Page](https://github.com/remix-run/remix/releases).
5
+
This page lists all releases/release notes for Remix back to `v2.0.0`. For releases prior to v2, please refer to the [GitHub Releases Page](https://github.com/remix-run/remix/releases).
6
6
7
-
We manage release notes in this file instead of the paginated Github Releases Page for 2 reasons:
7
+
We manage release notes in this file instead of the paginated GitHub Releases Page for 2 reasons:
8
8
9
-
- Pagination in the Github UI means that you cannot easily search release notes for a large span of releases at once
10
-
- The paginated Github interface also cuts off longer releases notes without indication in list view, and you need to click into the detail view to see the full set of release notes
9
+
- Pagination in the GitHub UI means that you cannot easily search release notes for a large span of releases at once
10
+
- The paginated GitHub interface also cuts off longer releases notes without indication in list view, and you need to click into the detail view to see the full set of release notes
New releases should be created from release branches originating from the `dev` branch. When you are ready to begin the release process:
40
40
41
-
- Make sure you've pulled all of the changes from GitHub for both `dev` and `main` branches
41
+
- Make sure you've pulled all the changes from GitHub for both `dev` and `main` branches
42
42
- Check out the `dev` branch
43
43
- If needed, bump the dependencies to the correct React Router release
44
44
-`./scripts/bump-router-versions.sh [pre|latest]`
@@ -54,7 +54,7 @@ Changesets will do most of the heavy lifting for our releases. When changes are
54
54
- Ensure you are on the new `release-*` branch
55
55
- Enter Changesets pre-release mode using the `pre` tag: `pnpm changeset pre enter pre`
56
56
- Commit the change and push the `release-*` branch to GitHub
57
-
- 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
57
+
- 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
58
58
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR into the `release-*` branch
- Once the PR is merged, the release workflow will publish the updated packages to npm
@@ -65,12 +65,12 @@ Changesets will do most of the heavy lifting for our releases. When changes are
65
65
66
66
### Iterating a pre-release
67
67
68
-
You may need to make changes to a pre-release prior to publishing a final stable release. To do so:
68
+
You may need to make changes to a pre-release before publishing a final stable release. To do so:
69
69
70
70
- Make whatever changes you need
71
71
- Create a new changeset: `pnpm changeset`
72
72
-**IMPORTANT:** This is required even if you ultimately don't want to include these changes in the logs
73
-
- 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
73
+
- Remember, changelogs can be edited before publishing, but the Changeset version script needs to see new changesets to create a new version
74
74
- Commit the changesets and push the `release-*` branch to GitHub
75
75
- Wait for the release workflow to finish and the Changesets action to open its PR that will increment all versions
76
76
- Review the PR, make any adjustments necessary, and merge it into the `release-*` branch
@@ -81,7 +81,7 @@ You may need to make changes to a pre-release prior to publishing a final stable
81
81
82
82
- Exit Changesets pre-release mode: `pnpm changeset pre exit`
83
83
- Commit the edited `pre.json` file along with any unpublished changesets, and push the `release-*` branch to GitHub
84
-
- 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
84
+
- 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
85
85
- Review the updated `CHANGELOG` files and make any adjustments necessary
- Our automated release process should have removed prerelease entries
@@ -104,25 +104,25 @@ Hotfix releases follow the same process as standard releases above, but the `rel
104
104
105
105
### Experimental releases
106
106
107
-
Experimental releases use a [manually-triggered Github Actions workflow](./.github/workflows/release-experimental.yml) and can be built from any existing branch. to build and publish an experimental release:
107
+
Experimental releases use a [manuallytriggered GitHub Actions workflow](./.github/workflows/release-experimental.yml) and can be built from any existing branch. To build and publish an experimental release:
108
108
109
109
- Commit your changes to a branch
110
-
- Push the branch to github
111
-
- Go to the Github Actions UI for the [release-experimental.yml workflow](https://github.com/remix-run/remix/actions/workflows/release-experimental-dispatch.yml)
110
+
- Push the branch to GitHub
111
+
- Go to the GitHub Actions UI for the [release-experimental.yml workflow](https://github.com/remix-run/remix/actions/workflows/release-experimental-dispatch.yml)
112
112
- Click the `Run workflow` dropdown
113
113
- Leave the `Use workflow from` dropdown as `main`
114
114
- Enter your feature branch in the `branch` input
115
115
- Click the `Run workflow` button
116
116
117
117
### Nightly releases
118
118
119
-
Nightly releases happen automatically at midnight PST via a [cron-driven workflow](./.github/workflows/nightly.yml) that is essentially the same as the experimental releases, but also performs some validations after the release.
119
+
Nightly releases happen automatically at midnight PST via a [cron-driven workflow](./.github/workflows/nightly.yml) that is essentially the same as the experimental releases but also performs some validations after the release.
120
120
121
121
## Local Development Tips and Tricks
122
122
123
123
### Environment Variables
124
124
125
-
This repository supports handful of environment variables to streamline the local development/testing process.
125
+
This repository supports a handful of environment variables to streamline the local development/testing process.
126
126
127
127
**`REMIX_DEBUG`**
128
128
@@ -134,7 +134,7 @@ REMIX_DEBUG=true pnpm watch
134
134
135
135
**`LOCAL_BUILD_DIRECTORY`**
136
136
137
-
When developing Remix locally, you often need to go beyond unit/integration tests and test your changes in a local Remix application. The easiest way to do this is to run your local Remix build and use this environment variable to direct `rollup` to write the output files directly into the local Remix application's `node_modules` folder. Then you just need to restart your local Remix application server to pick up the changes.
137
+
When developing Remix locally, you often need to go beyond unit/integration tests and test your changes in a local Remix application. The easiest way to do this is to run your local Remix build and use this environment variable to direct `rollup` to write the output files directly into the local Remix application's `node_modules` folder. Then you need to restart your local Remix application server to pick up the changes.
138
138
139
139
```sh
140
140
# Tab 1 - create and run a local remix application
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@
9
9
10
10
We are happy you're here!
11
11
12
-
[Remix](https://remix.run) is a fullstack web framework that lets you focus on the user interface and work back through web fundamentals to deliver a fast, slick, and resilient user experience that deploys to any Node.js server and even non-Node.js environments at the edge like Cloudflare Workers.
12
+
[Remix](https://remix.run) is a full-stack web framework that lets you focus on the user interface and work back through web fundamentals to deliver a fast, slick, and resilient user experience that deploys to any Node.js server and even non-Node.js environments at the edge like Cloudflare Workers.
13
13
14
14
Want to know more? Read the [Technical Explanation of Remix](https://remix.run/discussion/introduction).
15
15
@@ -30,4 +30,4 @@ If you're interested in contributing code and/or documentation, please see [our
30
30
31
31
## Code of Conduct
32
32
33
-
Please see our [code of conduct](CODE_OF_CONDUCT.md) for any questions about the kind of community we are trying to build here and what to do if you need help with someone who is not acting professionally.
33
+
Please see our [code of conduct](CODE_OF_CONDUCT.md) for any questions about the kind of community we are trying to build here and what to do if you need help with someone not acting professionally.
0 commit comments