Skip to content

Commit

Permalink
Update development docs on 6.x releases
Browse files Browse the repository at this point in the history
  • Loading branch information
brophdawg11 committed Sep 18, 2024
1 parent 7372aff commit 9c32cfa
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,30 @@ You may need to make changes to a pre-release prior to publishing a final stable

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.

### 6.x releases from the `v6` branch

After the `6.25.0` release, we branched off a `v6` branch for continued `6.x` work and merged the `v7` branch into `dev` to begin preparation for the `7.0.0` release. Until we launch `7.0.0`, we need to `6.x` releases in a slightly different manner.

- Changes for 6.x should be PR'd to the `v6` branch with a changeset
- Once merged, cherry-pick or re-do those changes against the `dev` branch so that they show up in v7
- This does not apply to things like adding deprecation warnings that should not land in v7
- You should not include a changelog in your commit to `dev`
- Starting the release process for 6.x is the same as outlined above, with a few changes:
- Branch from `v6` instead of `dev`
- Do not merge `main` into the `release-*` branch
- The process of the PRs and iterating on prereleases remains the same
- Once the stable release is out:
- Merge `release-next` back to `v6` with a **Normal Merge**
- Patch the changes into `main`
- `git checkout main`
- `git diff [email protected]@6.26.2 > ./changes.patch`
- `git apply changes.patch`
- The _code_ changes should already be in the `dev` branch but confirm that the commits in this release are all included in `dev` already:
- I.e., https://github.com/remix-run/react-router/compare/[email protected]@6.26.2
- If one or more are not, then you can manually bring them over by cherry-picking the commit (or re-doing the work)
- You should not include a changelog in your commit to `dev`
- Copy the updated changelogs from `release-next` over to `dev` so the changelogs continue to reflect this new 6x release into the v7 releases

### Experimental releases

Experimental releases and hot-fixes do not need to be branched off of `dev`. Experimental releases can be branched from anywhere as they are not intended for general use.
Expand Down

0 comments on commit 9c32cfa

Please sign in to comment.