From c121e0b2cf304c2a6826bfead7bdf5aad2cd0800 Mon Sep 17 00:00:00 2001 From: Daniele Calleri Date: Fri, 29 Dec 2023 16:37:32 +0100 Subject: [PATCH] docs: update release process --- RELEASE.md | 40 ++++++---------------------------------- 1 file changed, 6 insertions(+), 34 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index f9270a96..fdd858f6 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,40 +1,12 @@ # Release Process -Releases are mostly automated using +Releases are automated using [release-it](https://github.com/release-it/release-it/) and [conventional-changelog](https://github.com/release-it/conventional-changelog). -## Release +## How to release -The release process is straightforward: - -- First, ensure that you have installed your project’s dependencies: - -```sh -pnpm install -``` - -- Second, ensure that you have obtained a - [GitHub personal access token][generate-token] with the `repo` scope (no - other permissions are needed). Make sure the token is available as the - `GITHUB_AUTH` environment variable. - - For instance: - - ```bash - export GITHUB_AUTH=abc123def456 - ``` - -[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable - -- And last (but not least 😁) do your release. - -```sh -pnpm release -``` - -[release-it](https://github.com/release-it/release-it/) manages the actual -release process. It will prompt you to to choose the version number after which -you will have the chance to hand tweak the changelog to be used (for the -`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging, -pushing the tag and commits, etc. +- [Click here](https://github.com/qonto/ember-lottie/actions/workflows/release.yml) to visit the page for the `release` Action +- If you have the right **permissions**, you will see a "Run workflow" button, click on it +- Click on "Run workflow" in the dropdown +- The pipeline will release on GitHub and npm for you, enjoy!