release-it /release-it
๐ Automate versioning and package publishing
โ
9,085โ 579๐ 30โ 496โ 827โค 416
+2
Daily
9,085
stars
579
forks
30
watchers
496
prs
827
issues
416
releases
README
Release It! ๐
๐ Generic CLI tool to automate versioning and package publishing-related tasks:
- Bump version (in e.g. package.json)
- [Git commit, tag, push][1]
- Execute any (test or build) commands using [hooks][2]
- [Create release at GitHub][3] or [GitLab][4]
- [Generate changelog][5]
- [Publish to npm][6]
- [Manage pre-releases][7]
- Extend with [plugins][8]
- Release from any [CI/CD environment][9]
Use release-it for version management and publish to anywhere with its versatile configuration, a powerful plugin
system, and hooks to execute any command you need to test, build, and/or publish your project.
[![Action Status][11]][10] [![npm version][13]][12]
Are you using release-it at work? Please consider [sponsoring me][14]!
Installation
Although release-it is a generic release tool, most projects use it for projects with npm packages. The recommended
way to install release-it uses npm and adds some minimal configuration to get started:
bash
npm init release-it
Alternatively, install it manually, and add the release script to package.json:
bash
npm install -D release-it
json
{
"name": "my-package",
"version": "1.0.0",
"scripts": {
"release": "release-it"
},
"devDependencies": {
"release-it": "^21.0.0"
}
}
Usage
Run release-it from the root of the project using either npm run or npx:
bash
npm run release
npx release-it
You will be prompted to select the new version, and more prompts will follow based on your configuration.
Yarn & pnpm
- Using Yarn? Please see the [npm section on Yarn][15].
- Using pnpm? Please see [release-it-pnpm][16].
Monorepos
Using a monorepo? Please see this [monorepo recipe][17].
Global Installation
Per-project installation as shown above is recommended, but global installs are supported as well:
- From npm: npm install -g release-it
- From Homebrew: brew install release-it
Containerized
Use [Release It! - Containerized][18] to run it in any environment as a standardized container without the need for a
Node environment. Thanks [Juan Carlos][19]!
Videos, articles & examples
Here's a list of interesting external resources:
- Video: [How to use GitHub Actions & Release-It to Easily Release Your Code][20]
- Article: [Monorepo Semantic Releases][21] ([repo][22])
Want to add yours to the list? Just open a pull request!
Configuration
Out of the box, release-it has sane defaults, and [plenty of options][23] to configure it. Most projects use a
.release-it.json file in the project root, or a release-it property in package.json.
Here's a quick example .release-it.json:
json
{
"$schema": "https://unpkg.com/release-it@20/schema/release-it.json",
"git": {
"commitMessage": "chore: release v${version}"
},
"github": {
"release": true
}
}
โ See [Configuration][24] for more details.
Interactive vs. CI mode
By default, release-it is interactive and allows you to confirm each task before execution:
By using the --ci option, the process is fully autTop issues
Latest release
Release 21.1.2 21.1.2 2026-10-30Update pnpm to 11.28.10 (3112b7a569de3c807e72fb0fd5465d6a577cfe4e) Map ssh.github.com to github.com for release URLs (resolve 1344) (ce51fd14290e8ef95006ae198ffc012cb43d8808) Update undici to 7.30.1 (0afee0b363f02ece2dbe1d747ca91edb5f14695a) Show the GitLab error message for failed requests (8b21da45c9d901565359a7f9c523956bc907ac15) Pass branch, tag and remote names to git as arguments (resolve 1341) (dd963d54d767ec4cac0c95f088600b9cff5d23f5)