English | 简体中文

Verso is a small release CLI for JavaScript workspaces that publish multiple packages at the same version. It updates package manifests, writes an Angular-style conventional changelog, creates a release commit and tag, and atomically pushes the current upstream branch and release tag.

pnpm add -D @amamo/verso

Add a release script to your package manifest:

{
  "scripts": {
    "release": "verso"
  }
}

Every key is optional. verso init writes a starter config; without one, Verso falls back to built-in defaults when a root package.json exists.

Most workspace projects only need workspaces.patterns. If you omit it, Verso reads pnpm-workspace.yaml or the root manifest's workspaces field before falling back to single-package mode.

[version]
root_package = "package.json"
require_consistent_versions = true
cargo_manifest_paths = []

[workspaces]
patterns = []
include_root = true
ignore = []
use_gitignore = true

[changelog]
enabled = true
infile = "CHANGELOG.md"
preset = "angular"

[git]
require_clean_worktree = true
commit_message = "chore(release): release v${version}"
tag_name = "v${version}"
push = "atomic"

[hooks]
# before_version = "pnpm test"
# after_version = "pnpm build"
# before_commit = "pnpm lint"
# after_push = "node scripts/notify-release.mts"

[github_release]
enabled = false

Explicit --config <PATH> values must always point at a real file. Package discovery supports package.json, package.json5, package.yaml, and package.yml; when several manifests sit in the same directory, Verso picks in that order. The legacy git.push = "follow-tags" value is accepted as an alias for the safer atomic mode.

pnpm release
pnpm release -- --dry-run
pnpm release -- --version 0.26.0
pnpm release -- --version 0.26.0 --yes
pnpm release -- --dry-run --json
pnpm release -- --config path/to/verso.toml
pnpm release -- doctor
pnpm release -- init
pnpm release -- -V
pnpm release -- --help

Subcommands:

Without --version, Verso opens an interactive menu for patch, minor, major, alpha, beta, rc, or custom semver. When the current version is a prerelease, the menu also offers its stable version. Prerelease channels then prompt for a base version choice, including a custom base version. Exact versions can be passed with --version, including prereleases such as 0.26.0-alpha.0, 0.26.0-beta.1, and 0.26.0-rc.2.

Use --config to point at a different config file. Use --yes to skip release confirmation prompts, including the default-no confirmation shown when a target version is not greater than the current version. --yes does not choose a version for you; without --version, interactive version selection still runs. Use -V or --tool-version to print the installed Verso CLI version without reading release config.

When stdin or stdout is not attached to a terminal, Verso keeps a plain text prompt fallback so scripted tests and piped input can continue to choose by name, such as beta followed by minor.

            +----------------------------+
            |  Read verso.toml +         |
            |  discover manifests        |
            +-------------+--------------+
                          |
                          v
            +----------------------------+
            |  Resolve version           |
            |  (menu / --version)        |
            +-------------+--------------+
                          |
                          v
            +----------------------------+
            |  Write version files       |
            |  o manifests               |
            |  o Cargo.toml + Cargo.lock |
            |  o CHANGELOG.md prepend    |
            +-------------+--------------+
                          |
                          v
            +----------------------------+
            |  Commit                    |
            +-------------+--------------+
                          |
                          v
            +----------------------------+
            |  Tag                       |
            +-------------+--------------+
                          |
                          v
            +----------------------------+
            |  Atomic branch + tag push  |
            +----------------------------+

  -- [hooks] fire between steps
  -- --dry-run short-circuits every mutating step (no writes, no git)
  -- local failure: rollback files + unstage; push failure: keep commit/tag

Maintainer development and publishing details live in CONTRIBUTING.md.