-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f0ad6cb
commit 92f0208
Showing
5 changed files
with
30 additions
and
22 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
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
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 |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Releasing | ||
|
||
In order to release a new version, here is what we can do. | ||
|
||
First get a recommended release type by running | ||
|
||
```sh | ||
npm run version:recommend | ||
``` | ||
|
||
This will recommend one of the following release types depending on the commit history: `patch`, `minor` or `major` . We can use the recommended bump to release a new version. | ||
|
||
```sh | ||
npm run version:bump patch | ||
``` | ||
|
||
This command; | ||
|
||
- Runs tests and linters, builds project. | ||
- Updates version number in package.json. | ||
- Generates a [CHANGELOG](CHANGELOG.md) based on the latest commits. (See [Conventional Commits](https://github.com/conventional-changelog)) | ||
- Commits these changes with a message like `chore(RELEASE): publish %s` and creates a new tag with the version number. | ||
- Pushes all these changes to upstream. | ||
|
||
CI/CD will take care of the rest and publish the project to the npm registry and GitHub releases with the newly tagged version. |
This file was deleted.
Oops, something went wrong.
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