uplift

Semantic versioning the easy way. Automatic tagging and version bumping of files in your respositories based on your commit messages. Powered by Conventional Commits. Easy to include in your CI.

Github action available.

Install

Binary downloads of uplift can be found on the Releases page. Unpack the uplift binary and add it to your PATH.

Homebrew

To use Homebrew:

brew tap gembaadvantage/tap
brew install uplift

GoFish

To use Fish:

gofish install uplift

Scoop

To use Scoop:

scoop install uplift

Script

To install using a shell script:

curl https://raw.githubusercontent.com/gembaadvantage/uplift/master/scripts/install > install
chmod 700 install
./install

Quick Start

Uplift can carry out different semantic versioning operations on your repository. All operations support running in a dry run mode (--dry-run), providing a preview of changes only. Extra output can be logged to console using debug mode (--debug).

Uplift supports the use of a v prefix and includes it with subsequent bumps.

Tagging

Based on the latest commit, the repository will be tagged with the next semantic version.

$ uplift tag

  • current version
    • identified version        current=0.1.2
  • next version
    • identified next version   commit=feat: new feature current=0.1.2 next=0.2.0
  • next commit
    • committing with           email=joe.bloggs@example.com message=ci(bump): bumped version to 0.2.0 name=joe.bloggs
  • tag
    • with standard tag         tag=0.2.0

File Bumping

When configured, the version within any file in a git repository can be bumped to the next semantic version. The version is identified by inspecting the latest commit.

$ uplift bump

  • current version
    • identified version        current=0.2.0
  • next version
    • identified next version   commit=feat: new feature current=0.2.0 next=0.3.0
  • next commit
    • committing with           email=joe.bloggs@example.com message=ci(bump): bumped version to 0.2.0 name=joe.bloggs
  • bump
    • file bumped               current=0.2.0 file=chart/test/Chart.yaml next=0.3.0
    • successfully staged file  file=chart/test/Chart.yaml
    • attempting to commit file changes
  • git push
    • check and push any outstanding commits

Release

A full semantic release will be carried out. Combining both the bump and tag operations, in that order.

uplift release

Configuration

Uplift can be configured through the existance of an optional .uplift.yml configuration file in the root of your repository. Other supported variations are: .uplift.yaml, uplift.yml and uplift.yaml.

# An initial version that will be used for the first tag in your repository.
# Tags with a 'v' prefix are supported. You cannot change format after the first tag
# Defaults to 0.1.0
firstVersion: v1.0.0

# Use annotated tags instead of lightweight tags when tagging a version bump. An
# annotated tag is treated like a regular commit and contains both author details
# and a commit message. Uses the same commit message and author details provided
# Defaults to false
annotatedTags: true

# Changes the commit message when bumping files
# Defaults to ci(bump): bumped version to $VERSION
commitMessage: "chore: a custom commit message"

# Changes the commit author when bumping files
commitAuthor:
  # Name of the author
  # Defaults to the author name within the last commit
  name: "joe.bloggs"

  # Email of the author
  # Defaults to the author email within the last commit
  email: "joe.bloggs@gmail.com"

# A list of files whose version numbers should be bumped and kept in sync with the
# latest calculated repository tag.
# Defaults to an empty list
bumps:
  - # The path of the file relative to where uplift is executed
    file: ./chart/my-chart/Chart.yaml

    # A regex for matching a version within the file
    regex: "version: $VERSION"

    # If the matched version in the file should be replaced with a semantic version.
    # This will strip any 'v' prefix if needed
    # Defaults to false
    semver: true

    # The number of times any matched version should be replaced
    # Defaults to 0, which replaces all matches
    count: 1

$VERSION

$VERSION is a placeholder and will match any semantic version, including a version with an optional v prefix.

Transient Tags

Uplift automatically ignores any transient tag when identifying the latest version. This allows multiple tagging conventions to be safely used on your repository. A transient tag, is any tag that is not in the 1.0.0 or v1.0.0 version format.

abdirahmanjama/uplift