#version-bump #semver #version #numbers #pre-release #identifier #bumping

build semver-bump

A command-line tool for bumping semver-compliant version numbers

1 stable release

1.0.1 Nov 13, 2024

#220 in Command line utilities

Download history 92/week @ 2024-11-08 25/week @ 2024-11-15 24/week @ 2024-11-22 8/week @ 2024-11-29

149 downloads per month

Parity-7.0.0

19KB
258 lines

semver-bump 🤜🤛

Tests

A tool for bumping version numbers in a semantic-version-compatible way, designed to be used in a shell scripting context. It takes the previous version number as input from stdin, bumps the segment you requested to be bumped, and emits the result to stdout with no other noise. It also handles bumping pre-release and build identifiers as well, so you can increment 3.0.0-alpha.1 to 3.0.0-alpha.2.

Usage

There are five commands. The prerelease and build commands take an optional replacement identifier string parameter.

> semver-bump help

Read a semver-compliant version number from stdin and bump the
number as requested, writing the result to stdout

Usage: semver-bump <COMMAND>

Commands:
  major       Bump the major version number for a breaking change
  minor       Bump the minor version number for a new feature
  patch       Bump the patch version number for a bug fix
  prerelease  Bump any version number at the end of a pre-release identifier
  build       Bump any version number at the end of a build identifier
  help        Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Examples

Here we bump the version number of semver-bump itself:

#!/usr/bin/env bash
set -e
old=$(tomato get package.version Cargo.toml)
version=$(echo "$old" | cargo run -- "$1")
tomato set package.version "$version" Cargo.toml
cargo check
git commit Cargo.toml Cargo.lock -m "v$version"
git tag "$version"
echo "Release tagged for version $version"

A nearly identical version of this is in the justfile for this repo. You can use cargo-edit for this specific use case if you don't need to manage pre-release or build identifiers. The use case I had in mind was automatic version bumping and tagging for a project in a language other than Rust.

Here are some examples of the prerelease bumping behavior. There are some restrictions on what characters are allowed in the semver prerelease identifiers, and the semver crate's implementation is stricter than some.

> echo 1.2.3-alpha.4 | semver-bump prerelease
1.2.3-alpha.5

> echo 1.2.3-cetialpha4 | semver-bump prerelease
1.2.3-cetialpha5

> echo 1.2.3-ceti-alpha-4 | semver-bump prerelease
1.2.3-ceti-alpha-5

> echo 1.2.3-ceti-alpha-5 | semver-bump prerelease beta
1.2.3-beta-1

> echo 1.0.0 | semver-bump prerelease
Error: The current version does not have a prerelease suffix and you did not provide one.

> echo 1.0.0 | semver-bump prerelease +illegal+
Error: unexpected character in pre-release identifier

Bumping the build metadata component is an edge use case, but this tool supports doing so if somebody needs it.

> echo 1.0.3-rc.2+build-4 | semver-bump build
1.0.3-rc.2+build-5

LICENSE

This code is licensed via the Parity Public License. This license requires people who build on top of this source code to share their work with the community, too. See the license text for details.

Dependencies

~3–11MB
~144K SLoC