@release-git/release-git

v16.0.0

Published

a year ago

Generic CLI tool to automate versioning and package publishing-related tasks.

Downloads

0High
0Medium
0Low

build changelog commit distribution git github gitlab interactive ci npm publish push release release-git repository script shell tag tool version semver plugin

Release It! 🚀

🚀 Generic CLI tool to automate versioning and package publishing-related tasks:

Bump version (in e.g. package.json)
Git commit, tag, push
Execute any (test or build) commands using hooks
Create release at GitHub or GitLab
Generate changelog
Publish to npm
Manage pre-releases
Extend with plugins
Release from any CI/CD environment

Use release-git 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.

Installation

Although release-git is a generic release tool, most projects use it for projects with npm packages. The recommended way to install release-git uses npm and adds some minimal configuration to get started:

npm init release-git

Alternatively, install it manually, and add the release script to package.json:

npm install -D release-git

{
  "name": "my-package",
  "version": "1.0.0",
  "scripts": {
    "release": "release-git"
  },
  "devDependencies": {
    "release-git": "^15.10.0"
  }
}

Usage

Run release-git from the root of the project using either npm run or npx:

npm run release
npx release-git

You will be prompted to select the new version, and more prompts will follow based on your configuration.

Experimental: knowledge base

You might want to ask your questions in the Release It! knowledge base (powered by OpenAI and 7-docs). This is an experimental knowledge base, answers may be incorrect.

Yarn

Using Yarn? Please see the npm section on Yarn.

Monorepos

Using a monorepo? Please see this monorepo recipe.

Global Installation

Per-project installation as shown above is recommended, but global installs are supported as well:

From npm: npm install -g release-git
From Homebrew: brew install release-git

Videos, articles & examples

Here's a list of interesting external resources:

Video: How to use GitHub Actions & Release-Git to Easily Release Your Code
Article: Monorepo Semantic Releases (repo)

Want to add yours to the list? Just open a pull request!

Configuration

Out of the box, release-git has sane defaults, and plenty of options to configure it. Most projects use a .release-git.json file in the project root, or a release-git property in package.json.

Here's a quick example .release-git.json:

{
  "git": {
    "commitMessage": "chore: release v${version}"
  },
  "github": {
    "release": true
  }
}

→ See Configuration for more details.

Interactive vs. CI mode

By default, release-git is interactive and allows you to confirm each task before execution:

By using the --ci option, the process is fully automated without prompts. The configured tasks will be executed as demonstrated in the first animation above. In a Continuous Integration (CI) environment, this non-interactive mode is activated automatically.

Use --only-version to use a prompt only to determine the version, and automate the rest.

Latest version

How does release-git determine the latest version?

For projects with a package.json, its version will be used (see npm to skip this).
Otherwise, release-git uses the latest Git tag to determine which version should be released.
As a last resort, 0.0.0 will be used as the latest version.

Alternatively, a plugin can be used to override this (e.g. to manage a VERSION or composer.json file):

@release-git/bumper to read from or bump the version in any file
@release-git/conventional-changelog to get a recommended bump based on commit messages
release-git-calver-plugin to use CalVer (Calendar Versioning)

Add the --release-version flag to print the next version without releasing anything.

Git

Git projects are supported well by release-git, automating the tasks to stage, commit, tag and push releases to any Git remote.

→ See Git for more details.

GitHub Releases

GitHub projects can have releases attached to Git tags, containing release notes and assets. There are two ways to add GitHub releases in your release-git flow:

Automated (requires a GITHUB_TOKEN)
Manual (using the GitHub web interface with pre-populated fields)

→ See GitHub Releases for more details.

GitLab Releases

GitLab projects can have releases attached to Git tags, containing release notes and assets. To automate GitLab releases:

Configure gitlab.release: true
Obtain a personal access token (release-git only needs the "api" scope).
Make sure the token is available as an environment variable.

→ See GitLab Releases for more details.

Changelog

By default, release-git generates a changelog, to show and help select a version for the new release. Additionally, this changelog serves as the release notes for the GitHub or GitLab release.

The default command is based on git log .... This setting (git.changelog) can be overridden. To further customize the release notes for the GitHub or GitLab release, there's github.releaseNotes or gitlab.releaseNotes. Make sure any of these commands output the changelog to stdout. Note that release-git by default is agnostic to commit message conventions. Plugins are available for:

GitHub and GitLab Releases
auto-changelog
Conventional Changelog
Keep A Changelog

To print the changelog without releasing anything, add the --changelog flag.

→ See Changelog for more details.

Publish to npm

With a package.json in the current directory, release-git will let npm bump the version in package.json (and package-lock.json if present), and publish to the npm registry.

→ See Publish to npm for more details.

Manage pre-releases

With release-git, it's easy to create pre-releases: a version of your software that you want to make available, while it's not in the stable semver range yet. Often "alpha", "beta", and "rc" (release candidate) are used as identifiers for pre-releases. An example pre-release version is 2.0.0-beta.0.

→ See Manage pre-releases for more details.

Update or re-run existing releases

Use --no-increment to not increment the last version, but update the last existing tag/version.

This may be helpful in cases where the version was already incremented. Here are a few example scenarios:

To update or publish a (draft) GitHub Release for an existing Git tag.
Publishing to npm succeeded, but pushing the Git tag to the remote failed. Then use release-git --no-increment --no-npm to skip the npm publish and try pushing the same Git tag again.

Hooks

Use script hooks to run shell commands at any moment during the release process (such as before:init or after:release).

The format is [prefix]:[hook] or [prefix]:[plugin]:[hook]:

| part | value | | ------ | ------------------------------------------- | | prefix | before or after | | plugin | version, git, npm, github, gitlab | | hook | init, bump, release |

Use the optional :plugin part in the middle to hook into a life cycle method exactly before or after any plugin.

The core plugins include version, git, npm, github, gitlab.

Note that hooks like after:git:release will not run when either the git push failed, or when it is configured not to be executed (e.g. git.push: false). See execution order for more details on execution order of plugin lifecycle methods.

All commands can use configuration variables (like template strings). An array of commands can also be provided, they will run one after another. Some example release-git configuration:

{
  "hooks": {
    "before:init": ["npm run lint", "npm test"],
    "after:my-plugin:bump": "./bin/my-script.sh",
    "after:bump": "npm run build",
    "after:git:release": "echo After git push, before github release",
    "after:release": "echo Successfully released ${name} v${version} to ${repo.repository}."
  }
}

The variables can be found in the default configuration. Additionally, the following variables are exposed:

version
latestVersion
changelog
name
repo.remote, repo.protocol, repo.host, repo.owner, repo.repository, repo.project
branchName

All variables are available in all hooks. The only exception is that the additional variables listed above are not yet available in the init hook.

Use --verbose to log the output of the commands.

For the sake of verbosity, the full list of hooks is actually: init, beforeBump, bump, beforeRelease, release or afterRelease. However, hooks like before:beforeRelease look weird and are usually not useful in practice.

Note that arguments need to be quoted properly when used from the command line:

release-git --'hooks.after:release="echo Successfully released ${name} v${version} to ${repo.repository}."'

Using Inquirer.js inside custom hook scripts might cause issues (since release-git also uses this itself).

Dry Runs

Use --dry-run to show the interactivity and the commands it would execute.

→ See Dry Runs for more details.

Troubleshooting & debugging

With release-git --verbose (or -V), release-git prints the output of every user-defined hook.
With release-git -VV, release-git also prints the output of every internal command.
Use NODE_DEBUG=release-git:* release-git [...] to print configuration and more error details.

Use verbose: 2 in a configuration file to have the equivalent of -VV on the command line.

Plugins

Since v11, release-git can be extended in many, many ways. Here are some plugins:

| Plugin | Description | | ------------------------------------------ | ----------------------------------------------------------------------------- | | @release-git/bumper | Read & write the version from/to any file | | @release-git/conventional-changelog | Provides recommended bump, conventional-changelog, and updates CHANGELOG.md | | @release-git/keep-a-changelog | Maintain CHANGELOG.md using the Keep a Changelog standards | | @release-git-plugins/lerna-changelog | Integrates lerna-changelog into the release-git pipeline | | @release-git-plugins/workspaces | Releases each of your projects configured workspaces | | release-git-calver-plugin | Enables Calendar Versioning (calver) with release-git | | @grupoboticario/news-fragments | An easy way to generate your changelog file | | @j-ulrich/release-git-regex-bumper | Regular expression based version read/write plugin for release-git |

Internally, release-git uses its own plugin architecture (for Git, GitHub, GitLab, npm).

→ See all release-git plugins on npm.

→ See plugins for documentation to write plugins.

Use release-git programmatically

While mostly used as a CLI tool, release-git can be used as a dependency to integrate in your own scripts. See use release-git programmatically for example code.

Example projects using release-git

Legacy Node.js

The latest major version is v16, supporting Node.js 16 and up (as Node.js v14 is EOL). Use release-git v15 for environments running Node.js v14. Also see CHANGELOG.md.

License

MIT