conventional-release-setup

conventional-release-setup

Sets up an npm package for committing and releasing with conventional commits:

npx conventional-release-setup

Install

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

Explanation

What does the script do?

It updates package.json:

• appends -alpha to version
• adds script release

Installs devDependencies:

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

Copies configs to your project:

• .commitlintrc.json
• .huskyrc.json

Release

If -alpha is appended to your package.json version:

{
  "version": "1.0.0-alpha"
}

You can run a release like so:

npm run release # npx standard-version --no-verify

Otherwise, you can release as a target type imperatively:

npx standard-version --release-as 1.0.0

Or if you want to use the current version as your first release:

npx standard-version --first-release

Lint

Lint files:

npm run lint

Fix lint errors:

npm run lint:fix

Release

Only collaborators with credentials can release and publish:

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

License

MIT