Skip to main content

Changes

build

Lightweight and (hopefully) unopinionated tool for using Conventional Commits and Semantic Versioning with Git.

Overview

Many of the Semantic Versioning tools out there force very specific workflows that I found hard to adopt in my own projects. Changes attempts to provide a collection of tools that fit into your own project lifecycle by providing a collection of commands that can be assembled however you need.

Changes differs from many other solutions by using tags to mark commits in your repository as released. This allows releases to be made without modifying the source or making additional commits.

Installation

Changes is available via PyPI.

Install it using your Python package manager of choice. For example, using uv:

uv tool install changes-semver

Usage

Here are a few quick commands you can try to get you started—run these from within a Git repository with commit messages conforming to Conventional Commits:

  • Get the current version number:

    changes version --released
    
  • Get the next version number (accounting for changes since the last release tag):

    changes version
    
  • Get the latest release notes:

    changes notes --released
    
  • Get the released notes for the next version:

    changes notes
    
  • List the full history:

    changes notes --all	
    
  • Make a release:

    changes release
    

    (Tags the current sha with the new version if there are unreleased changes).

Find out more details using the --help command:

changes --help

Or see the details of specific sub-commands by passing the --help flag directly to those commands:

changes release --help

Alternative Histories

Sometimes you might need to provide your own list of changes for specific releases—this can be helpful if you forgot to adhere to Conventional Commits or, perhaps, you want to provide a custom list of changes for your initial release. Changes supports this, allowing you to replace the list of changes for any release specified a simple YAML file:

  1. Create a YAML file containing the releases you want to change. For example,

    "1.0.0":
    - "feat: Initial release"
    
  2. Pass this alternative history file to any changes command:

    changes notes --history history.yaml
    

[!NOTE]

Changes replaces all the changes in the named releases with those listed in the YAML file; you will need to manually include any change you want listed for releases you override.

Development

Setup

git clone git@github.com:jbmorley/changes.git
cd changes
pipenv install

Tests

Run tests locally using the test.sh script:

./scripts/test.sh

You can run a specific test by specifying the test class on the command line:

./scripts/test.sh test_cli.CLITestCase.test_version_multiple_changes_yield_single_increment

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

changes_semver-6.0.7.tar.gz (21.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

changes_semver-6.0.7-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file changes_semver-6.0.7.tar.gz.

File metadata

  • Download URL: changes_semver-6.0.7.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for changes_semver-6.0.7.tar.gz
Algorithm Hash digest
SHA256 af91c5cbea7dba79ca62dd0c678e585818c9e755d9bfd4e09e17ba900c23bff0
MD5 307ead4e493f829cf1931840f5fffbca
BLAKE2b-256 84f9dab32ec1eeaccc3654a50461749c4135b1bd8735feeaafa80fff87cba24d

See more details on using hashes here.

Provenance

The following attestation bundles were made for changes_semver-6.0.7.tar.gz:

Publisher: build.yaml on jbmorley/changes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file changes_semver-6.0.7-py3-none-any.whl.

File metadata

  • Download URL: changes_semver-6.0.7-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for changes_semver-6.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4686ecc6616673b9ba1376d19eb48e6741733dca192c03dfdbe7143b67e93664
MD5 0dd58bfb6f4a93fd28423a37a384edad
BLAKE2b-256 691fcfce3e8821741cd6aebf579c9a526f700f752aec3c8bcf8472be3b0eeb26

See more details on using hashes here.

Provenance

The following attestation bundles were made for changes_semver-6.0.7-py3-none-any.whl:

Publisher: build.yaml on jbmorley/changes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

6.0.8

2 files

This release

6.0.7 This release

2 files

6.0.6

2 files

6.0.5

2 files

6.0.4

2 files

6.0.3

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page