Getting Started

Prepare


npm install --save-dev release-it release-it-pnpm


pnpm add --save-dev release-it release-it-pnpm


yarn add --dev release-it release-it-pnpm


bun add --dev release-it release-it-pnpm

You can also install it globally


npm install --global release-it release-it-pnpm


pnpm add --global release-it release-it-pnpm


yarn global add release-it release-it-pnpm


bun add --global release-it release-it-pnpm

.release-it.json


{
  "plugins": {
    "release-it-pnpm": {}
  },
  "git": {
    "commitMessage": "chore: release ${version}"
  }
}

If you prefer to have a v prefix in the tag name, you can use the following configuration:

.release-it.json


{
  "plugins": {
    "release-it-pnpm": {}
  },
  "git": {
    "commitMessage": "chore: release v${version}",
    "tagName": "v${version}"
  }
}

Manually decide the next version


release-it

Use recommended version


release-it --ci

Override the recommended version in CI


release-it --ci --increment=minor

Choose a pre-release tag instead of the default beta


release-it --preRelease=alpha