Skip to content

Commit

Permalink
docs: update release guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
michelegera committed Jan 16, 2024
1 parent 5e1fdc6 commit ff30f12
Showing 1 changed file with 4 additions and 24 deletions.
28 changes: 4 additions & 24 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,13 @@

Releases are mostly automated using
[release-it](https://github.com/release-it/release-it/) and
[lerna-changelog](https://github.com/lerna/lerna-changelog/).

## Preparation

Since the majority of the actual release process is automated, the primary
remaining task prior to releasing is confirming that all pull requests that
have been merged since the last release have been labeled with the appropriate
`lerna-changelog` labels and the titles have been updated to ensure they
represent something that would make sense to our users. Some great information
on why this is important can be found at
[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall
guiding principle here is that changelogs are for humans, not machines.

When reviewing merged PR's the labels to be used are:

- breaking - Used when the PR is considered a breaking change.
- enhancement - Used when the PR adds a new feature or enhancement.
- bug - Used when the PR fixes a bug included in a previous release.
- documentation - Used when the PR adds or updates documentation.
- internal - Used for internal changes that still require a mention in the
changelog/release notes.
[conventional-changelog](https://github.com/release-it/conventional-changelog).

## Release

Once the prep work is completed, the actual release is straight forward:
The release process is straightforward:

- First, ensure that you have installed your projects dependencies:
- First, ensure that you have installed your project’s dependencies:

```sh
pnpm install
Expand All @@ -50,7 +30,7 @@ pnpm install
- And last (but not least 😁) do your release.

```sh
npx release-it
pnpm release
```

[release-it](https://github.com/release-it/release-it/) manages the actual
Expand Down

0 comments on commit ff30f12

Please sign in to comment.