-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update release docs to match new release workflow
- Loading branch information
1 parent
8c93164
commit f7d684d
Showing
1 changed file
with
7 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,12 @@ | ||
| # Release Process | ||
|
|
||
| Releases are mostly automated using | ||
| Releases are automated using | ||
| [release-it](https://github.com/release-it/release-it/) and | ||
| [lerna-changelog](https://github.com/lerna/lerna-changelog/). | ||
| [conventional-changelog](https://github.com/release-it/conventional-changelog). | ||
|
|
||
| ## Preparation | ||
| ## How to release | ||
|
|
||
| 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. | ||
|
|
||
| ## Release | ||
|
|
||
| Once the prep work is completed, the actual release is straight forward: | ||
|
|
||
| - First, ensure that you have installed your projects 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 | ||
| npx release-it | ||
| ``` | ||
|
|
||
| [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-phone-input/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! |