Skip to content

Commit

Permalink
Remove tags from CHANGELOG.md and update DEVELOPMENT.md
Browse files Browse the repository at this point in the history
  • Loading branch information
brophdawg11 committed Nov 16, 2023
1 parent c999836 commit f57b75c
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 14 deletions.
22 changes: 11 additions & 11 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ We manage release notes in this file instead of the paginated Github Releases Pa
<summary>Table of Contents</summary>

- [Remix Releases](#remix-releases)
- [v2.3.0 🏷️](#v230-️)
- [v2.3.0](#v230)
- [What's Changed](#whats-changed)
- [Stabilized `useBlocker`](#stabilized-useblocker)
- [`unstable_flushSync` API](#unstable_flushsync-api)
- [Minor Changes](#minor-changes)
- [Patch Changes](#patch-changes)
- [Updated Dependencies](#updated-dependencies)
- [Changes by Package](#changes-by-package)
- [v2.2.0 🏷️](#v220-️)
- [v2.2.0](#v220)
- [What's Changed](#whats-changed-1)
- [Vite!](#vite)
- [New Fetcher APIs](#new-fetcher-apis)
Expand All @@ -30,18 +30,18 @@ We manage release notes in this file instead of the paginated Github Releases Pa
- [Patch Changes](#patch-changes-1)
- [Updated Dependencies](#updated-dependencies-1)
- [Changes by Package](#changes-by-package-1)
- [v2.1.0 🏷️](#v210-️)
- [v2.1.0](#v210)
- [What's Changed](#whats-changed-2)
- [View Transitions](#view-transitions)
- [Stable `createRemixStub`](#stable-createremixstub)
- [Minor Changes](#minor-changes-2)
- [Patch Changes](#patch-changes-2)
- [Updated Dependencies](#updated-dependencies-2)
- [Changes by Package](#changes-by-package-2)
- [v2.0.1 🏷️](#v201-️)
- [v2.0.1](#v201)
- [Patch Changes](#patch-changes-3)
- [Changes by Package 🔗](#changes-by-package-)
- [v2.0.0 🏷️](#v200-️)
- [v2.0.0](#v200)
- [Breaking Changes](#breaking-changes)
- [Upgraded Dependency Requirements](#upgraded-dependency-requirements)
- [Removed Future Flags](#removed-future-flags)
Expand All @@ -59,7 +59,7 @@ We manage release notes in this file instead of the paginated Github Releases Pa
<!--
To add a new release, copy from this template:
## v2.X.Y [🏷️](https://github.com/remix-run/remix/releases/tag/remix%402.X.Y)
## v2.X.Y
### What's Changed
Expand Down Expand Up @@ -98,7 +98,7 @@ To add a new release, copy from this template:
-->

## v2.3.0 [🏷️](https://github.com/remix-run/remix/releases/tag/remix%402.3.0)
## v2.3.0

### What's Changed

Expand Down Expand Up @@ -176,7 +176,7 @@ function handleClick() {

**Full Changelog**: [`v2.2.0...v2.3.0`](https://github.com/remix-run/remix/compare/[email protected]@2.3.0)

## v2.2.0 [🏷️](https://github.com/remix-run/remix/releases/tag/remix%402.2.0)
## v2.2.0

### What's Changed

Expand Down Expand Up @@ -269,7 +269,7 @@ Per the same [RFC](https://github.com/remix-run/remix/discussions/7698) as above

**Full Changelog**: [`v2.1.0...v2.2.0`](https://github.com/remix-run/remix/compare/[email protected]@2.2.0)

## v2.1.0 [🏷️](https://github.com/remix-run/remix/releases/tag/remix%402.1.0)
## v2.1.0

### What's Changed

Expand Down Expand Up @@ -363,7 +363,7 @@ After real-world experience, we're confident in the [`createRemixStub`](https://

**Full Changelog**: [`v2.0.1...v2.1.0`](https://github.com/remix-run/remix/compare/[email protected]@2.1.0)

## v2.0.1 [🏷️](https://github.com/remix-run/remix/releases/tag/remix%402.0.1)
## v2.0.1

### Patch Changes

Expand Down Expand Up @@ -392,7 +392,7 @@ After real-world experience, we're confident in the [`createRemixStub`](https://

**Full Changelog**: [`v2.0.0...v2.0.1`](https://github.com/remix-run/remix/compare/[email protected]@2.0.1)

## v2.0.0 [🏷️](https://github.com/remix-run/remix/releases/tag/remix%402.0.0)
## v2.0.0

We're _**so**_ excited to release Remix v2 to you and we really hope this upgrade is one of the smoothest framework upgrades you've ever experienced! That was our primary goal with v2 - something we aimed to achieve through a heavy use of deprecation warnings and [Future Flags](https://remix.run/blog/future-flags) in Remix v1.

Expand Down
12 changes: 9 additions & 3 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ Changesets will do most of the heavy lifting for our releases. When changes are
- 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
- At this point, you can begin crafting the release notes for the eventual stable release in the root `CHANGELOG.md` file in the repo
- Copy the template for a new release and update the version numbers and links accordingly
- Copy the relevant changelog entries from all packages into the release notes and adjust accordingly
- Commit these changes directly to the `release-*` branch - they will not trigger a new prerelease since they do not include a changeset

### Iterating a pre-release

Expand All @@ -69,6 +73,7 @@ You may need to make changes to a pre-release prior to publishing a final stable
- 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
- Make sure you copy over the new changeset contents into stable release notes in the root `CHANGELOG.md` file in the repo

### Publishing the stable release

Expand All @@ -79,8 +84,9 @@ You may need to make changes to a pre-release prior to publishing a final stable
- `find packages -name 'CHANGELOG.md' -mindepth 2 -maxdepth 2 -exec code {} \;`
- We should remove the changelogs for all pre-releases ahead of publishing the stable version
- [TODO: We should automate this]
- Prepare the github release notes
- Copy the relevant changelog entries from all packages into the Release Notes and adjust accordingly, matching the format used by prior releases
- Finalize the release notes
- This should already be in pretty good shape in the root `CHANGELOG.md` file in the repo
- Do a quick double check that all iterated prerelease changesets got copied over
- 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:
Expand All @@ -89,7 +95,7 @@ You may need to make changes to a pre-release prior to publishing a final stable
- `git checkout main; git merge --no-ff release-next`
- Merge the `release-*` branch into `dev` **using a non-fast-forward merge** and push it up to GitHub
- `git checkout dev; git merge --no-ff release-next`
- Convert the `[email protected]` tag to a Release on Github with the name `v1.x.y` using he release notes prepared above
- Convert the `[email protected]` tag to a Release on GitHub with the name `v2.x.y` and add a deep-link to the release heading in `CHANGELOG.md`

### Hotfix releases

Expand Down

0 comments on commit f57b75c

Please sign in to comment.