Varlet Release

English | 中文

Intro

Varlet Release is a tool used for publishing all packages, generating change logs, and checking commit messages, relying on pnpm.

• 📦 Out of the box: Zero-configuration release experience
• 🤖 Interactive CLI: Friendly interactive terminal prompts
• 🛠 Standardization: Validates Git Commit messages and generates standard changelogs
• 🔗 Extensibility: Supports both CLI commands and Node.js API for deep customization

Varlet Release requires Node.js ^20.19.0 || >=22.12.0 and esm only.

Installation

pnpm add @varlet/release -D

Usage

Core Workflow

When executing vr release, the following sequence of lifecycles occurs automatically:

1. Select/Confirm the version to publish interactively
2. Execute the user-defined task function (optional, e.g., to rebuild projects based on the new version)
3. Update the package.json version programmatically
4. Generate the Changelog
5. Git Commit & Git Tag
6. Publish to npm

Using Command

# Release all packages and run the full workflow
npx vr release

# Specify remote name
npx vr release -r https://github.com/varletjs/varlet-release
# or
npx vr release --remote https://github.com/varletjs/varlet-release

# Just generate changelogs
npx vr changelog

# Specify changelog filename
npx vr changelog -f changelog.md
# or
npx vr changelog --file changelog.md

# Lint commit message
npx vr lint-commit -p .git/COMMIT_EDITMSG

# Publish to npm, which can be called in the ci environment
npx vr publish

Git Hooks Integration (Best Practice)

It is highly recommended to use commit-lint with simple-git-hooks or husky in package.json to automatically check developers' commit messages before committing:

{
  "simple-git-hooks": {
    "commit-msg": "npx vr lint-commit -p $1"
  }
}

Configuration

release

Params	Instructions	Default
-r --remote <remote>	Specify remote name	origin
-s --skip-npm-publish	Skip npm publish	false
-c --check-remote-version	Check if the remote version of the npm package is the same as the one you want to publish locally, if so, stop execution.	false
-sc --skip-changelog	Skip generate changelog	false
-sgt --skip-git-tag	Skip git tag	false
-nt --npm-tag <npmTag>	npm tag	-

changelog

Params	Instructions	Default
-f --file <filename>	Specify changelog filename	CHANGELOG.md
-rc --releaseCount <releaseCount>	Release count	0
-p --preset <preset>	Specify changelog preset	angular

lint-commit

Params	Instructions
-p --commitMessagePath <path>	The path of the temporary file to which the git message is submitted. The git hook commit-msg will pass this parameter
-r --commitMessageRe <reg>	Validate the regular of whether the commit message passes
-e --errorMessage <message>	Validation failed to display error messages
-w --warningMessage <message>	Validation failed to display warning messages

publish

Params	Instructions	Default
-c --check-remote-version	Detects whether the remote version of the npm package is the same as the package version to be published locally, and if it is, skip the release	false
-nt --npm-tag <npmTag>	npm tag	-

Node API Custom Handle

You can write your own release scripts with Internal Node.js API instead of CLI.

Example

import { changelog, release } from '@varlet/release'

// Run the core release workflow directly
release()

You can pass in a custom task function that will be called after the package version is updated but before the remaining publish steps.

import { changelog, release } from '@varlet/release'

async function task(newVersion, oldVersion) {
  await doSomething1()
  await doSomething2()
}

release({ task })

License

MIT