Skip to content

Commit

Permalink
Merge pull request #521 from qonto/update-release-process
Browse files Browse the repository at this point in the history
Update RELEASE.md
  • Loading branch information
dannycalleri authored Jan 5, 2024
2 parents 6381232 + d77a6d1 commit ec0a7c0
Showing 1 changed file with 6 additions and 32 deletions.
38 changes: 6 additions & 32 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,38 +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:

```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 run 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-autofocus-modifier/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!

0 comments on commit ec0a7c0

Please sign in to comment.