Run conventional-release-setup
in your Terminal to enable your project to be released with Conventional Commits:
$ npx conventional-release-setup
Motivation
Most of my projects rely on Conventional Commits for releasing. But because the setup is repetitive, I decided to automate the process.
So in the past, I would manually:
- set up commitlint:
- which checks if my commit messages meet the conventional commits format (this information is key when generating a release)
- add husky:
- which lints the commit message via a Git hook
- and include standard-version:
- which bumps the version and generate the CHANGELOG
Now I run the executable and it does all that for me.
Usage
If the binary is installed globally, you can execute it like so:
$ npm install --global conventional-release-setup
$ conventional-release-setup
Otherwise, execute it with npx:
$ npx conventional-release-setup
For your first release, it’s recommended to do the following:
# git stash
$ npm version 1.0.0
$ git add package.json
$ git commit -m 'chore(package): bump version to 1.0.0'
$ npx standard-version --first-release
# git stash pop
See standard-version > First Release for more details.
Package
You can find conventional-release-setup
on:
Feel free to check out the GitHub repository.