Interactive release tool for Git repositories. Increment version, commit, tag, push, build, publish to npm. Supports to build and release to a distribution/component repository.
Interactive release tool for Git repositories. Publish to npm. Optionally build and release to a distribution/component repository.
Automatically increments version in package.json, commit, tag, push, publish, done.
Obviously, Release It has released itself. Cool, heh?! There's also a Grunt plugin.
npm install release-it -g
Personally, I prefer to alias it to
The examples below assume this alias to be defined.
Release It can do a lot out-of-the-box, but has plenty of options to configure it.
$ release --helpRelease It! v0.0.9Usage: release <increment> [options]Use e.g. "release minor" directly as shorthand for "release --increment=minor".Options:-c, --config Path to local configuration options [default: ".release.json"]-d, --dry-run Do not touch or write anything, but show the commands and interactivity-e, --debug Output exceptions-f, --force Force tagging with Git-h, --help Print help-i, --increment Incrementing "major", "minor", or "patch" version; or specify version [default: "patch"]-n, --non-interactive No interaction (assume default answers to questions)-p, --publish Publish to npm (only in --non-interactive mode)-v, --version Print version number-V, --verbose Verbose output
"non-interactive": false"dry-run": false"verbose": false"force": false"pkgFiles": "package.json""increment": "patch""commitMessage": "Release %s""tagName": "%s""tagAnnotation": "Release %s""buildCommand": false"distRepo": false"distPkgFiles": undefined /* Defaults to pkgFiles */"distStageDir": ".stage""distBase": "dist""distFiles": "**/*""private": false"publish": false"publishPath": ".""githubTokenRef": "GITHUB_TOKEN""githubRelease": false"githubReleaseName": "Release %s""githubReleaseBodyCommand": "git log --pretty=format:'* %s (%h)' [REV_RANGE]"
If you also want to release to "distribution repo", you'll need to set
distRepo to a git endpoint (e.g.
.release.json file and Release It will use it to overwrite default settings. You can use
--config if you want to use another filename/location. Most options can be set on the command-line (these will have highest priority).
The tool assumes you've configured your SSH keys and remotes correctly. In case you need to configure things, the following pages might be of help.
To create GitHub releases, you'll need to set
githubRelease to true, get a GitHub access token, and make this available as the environment variable defined with
githubTokenRef. With the default settings, you could set it like this:
Many steps need your confirmation before execution.
By default, with the current repository:
pkgFileswill be incremented.
%sis replaced with the incremented version.
githubReleaseNameand output of
distRepo, the package can be published directly to npm.
Additionally, if a distribution repository is configured:
distRepois cloned in
distFilesare copied here (normalized by removing the
distBasefrom the target path).
If present, your
"private": true setting in package.json will be respected and you will not be bothered with the question to publish to npm.
Release a "patch" update (increments the
0.0.x by one):
Release a patch, minor, major, or specific version:
release minorrelease 0.8.3release 2.0.0-rc.3
You can also do a dry run, which won't write/touch anything, but does output the commands it would execute, and show the interactivity:
If you don't like questions and trust the tool, you can use the
Provide a custom name for the GitHub release:
release --githubReleaseName="Awesome Ants"
The following Grunt plugins have been a source of inspiration:
Why did I need to create yet another "release" tool/plugin? I think it..