-
-
Notifications
You must be signed in to change notification settings - Fork 10.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into release-next
- Loading branch information
Showing
7 changed files
with
49 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,42 +4,50 @@ | |
|
||
New releases should be created from release branches originating from the `dev` branch. When you are ready to begin the release process: | ||
|
||
- Make sure you've pulled all of the changes from GitHub for both `dev` and `main` branches | ||
- Check out the `dev` branch | ||
- Create a new release branch with the `release-` prefix (eg, `git checkout -b release-v6.5.1`) | ||
- Make sure you've pulled all of the changes from GitHub for both `dev` and `main` branches. | ||
- Check out the `dev` branch. | ||
- Create a new release branch with the `release-` prefix (eg, `git checkout -b release-next`). | ||
- **IMPORTANT:** The `release-` prefix is important, as this is what triggers our GitHub CI workflow that will ultimately publish the release. | ||
- Merge `main` into the release branch | ||
- Branches named `release-experimental` will not trigger our release workflow, as experimental releases handled differently (outlined below). | ||
- Merge `main` into the release branch. | ||
|
||
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. | ||
|
||
### Starting a new pre-release | ||
|
||
- Ensure you are on the new `release-*` branch | ||
- Enter Changesets pre-release mode using the `pre` tag: `yarn changeset pre enter pre` | ||
- 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 | ||
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR | ||
- Once the PR is merged, the release workflow will publish the updated packages to npm | ||
- Ensure you are on the new `release-*` branch. | ||
- Enter Changesets pre-release mode using the `pre` tag: `yarn changeset pre enter pre`. | ||
- Commit the change and push the the `release-*` branch to GitHub. | ||
- 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. | ||
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR into the `release-*` branch. | ||
- `find packages -name 'CHANGELOG.md' -mindepth 2 -maxdepth 2 -exec code {} \;` | ||
- Once the PR is merged, the release workflow will publish the updated packages to npm. | ||
|
||
### Iterating a pre-release | ||
|
||
You may need to make changes to a pre-release prior to publishing a final stable release. To do so: | ||
|
||
- Make whatever changes you need | ||
- Create a new changeset: `yarn changeset` | ||
- Make whatever changes you need. | ||
- Create a new changeset: `yarn changeset`. | ||
- **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. | ||
- 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 | ||
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR | ||
- Once the PR is merged, the release workflow will publish the updated packages to npm | ||
- 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. | ||
- Review the PR, make any adjustments necessary, and merge it into the `release-*` branch. | ||
- Once the PR is merged, the release workflow will publish the updated packages to npm. | ||
|
||
### Publishing the stable release | ||
|
||
- Exit Changesets pre-release mode: `yarn changeset pre exit` | ||
- 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 | ||
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR | ||
- Once the PR is merged, the release workflow will publish the updated packages to npm | ||
- Exit Changesets pre-release mode: `yarn changeset pre exit`. | ||
- Commit the deleted pre-release file along with any unpublished changesets, and push the the `release-*` branch to GitHub. | ||
- 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. | ||
- Review the updated `CHANGELOG` files and make any adjustments necessary. | ||
- We should remove the changelogs for all pre-releases ahead of publishing the stable version. | ||
- [TODO: We should automate this] | ||
- Merge the PR into the `release-*` branch. | ||
- Once the PR is merged, the release workflow will publish the updated packages to npm. | ||
- Once the release is published: | ||
- merge the `release-*` branch into `main` and push it up to github | ||
- merge the `release-*` branch into `dev` and push it up to github | ||
- merge the `release-*` branch into `main` and push it up to GitHub | ||
- merge the `release-*` branch into `dev` and push it up to GitHub | ||
- Convert the `[email protected]` tag to a Release on Github with the name `v6.x.y` | ||
- Copy the relevant changelog entries from all packages into the Release Notes and adjust accordingly, matching the format used by prior releases | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,6 +15,7 @@ const loader = async () => { | |
if (!user) { | ||
return redirect("/login"); | ||
} | ||
return null; | ||
}; | ||
``` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters