conventional-release-setup

conventional-release-setup

A command-line tool for setting up a package for committing and releasing with conventional commits:

$ npx conventional-release-setup

Installation

To install the package globally:

# with npm
$ npm install --global conventional-release-setup

# with yarn
$ yarn global add conventional-release-setup

Usage

If the package is installed globally, you can execute it in the command-line:

$ conventional-release-setup

Otherwise, you can install and execute the package binary like so:

$ npx conventional-release-setup

What does this script do?

It installs the devDependencies:

• @commitlint/cli - lints commit messages
• @commitlint/config-conventional - config with conventional commits rules
• husky - sets up Git hooks
• standard-version - generates changelog and bumps version

And copies the configs to your project root:

• .commitlintrc.json
• .huskyrc

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.

Release

Only collaborators with credentials can release and publish:

$ npm run release
$ git push --follow-tags && npm publish

License

MIT