From ff30f128593069b754d34b5381192b189802bd69 Mon Sep 17 00:00:00 2001 From: Michele Gerarduzzi Date: Tue, 16 Jan 2024 17:39:35 +0100 Subject: [PATCH] docs: update release guidelines --- RELEASE.md | 28 ++++------------------------ 1 file changed, 4 insertions(+), 24 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index a7861f35..f9270a96 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -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 @@ -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