Skip to main content

A CLI tool to manage project versioning and changelogs with Keep a Changelog compliance.

Project description

changelogbump

Python Poetry PyPI - Version

A command-line tool that updates a project's changelog and bumps its semantic version according to Keep a Changelog conventions.

Features

  • Initializes a new CHANGELOG.md file with a standard header.
  • Increments the project version (major, minor, or patch) and updates:
    • The pyproject.toml version.
    • The changelog, prompting for added, changed, or removed entries.
  • Helps maintain strict adherence to semantic versioning.

Installation

  1. Ensure you have Python 3.11 or newer installed.
  2. Install via pip:
    pip install changelogbump
    

Usage

From your terminal, run:

  • Initialize a fresh changelog in the project root (if not present):

    changelogbump init
    
  • Add and bump your version, specifying the part to increment:

    changelogbump add --major
    changelogbump add --minor
    changelogbump add --patch
    
  • Provide a summary for the version:

    changelogbump add --patch --summary "Small bug fixes"
    

You will be prompted for items to add under different sections (Added, Changed, Removed), which are appended to the changelog.

Contributing

Pull requests, issues, and feature requests are welcome! Feel free to check out the issues page.

License

This project is licensed under the MIT License.

Project details


Download files

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

Source Distribution

changelogbump-0.1.2.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

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

changelogbump-0.1.2-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file changelogbump-0.1.2.tar.gz.

File metadata

  • Download URL: changelogbump-0.1.2.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for changelogbump-0.1.2.tar.gz
Algorithm Hash digest
SHA256 9a862da72221d0a9d723264ef2f7d2d1eb85995eeb41b81bb5cca052510b477b
MD5 2b0c5f49a8282fe292704e8318008264
BLAKE2b-256 634d70676305561407b8724f3f40a9b2f795d372cad50d0894432136f8740f85

See more details on using hashes here.

Provenance

The following attestation bundles were made for changelogbump-0.1.2.tar.gz:

Publisher: python-publish.yml on muad-dweeb/ChangelogBump

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

File details

Details for the file changelogbump-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: changelogbump-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for changelogbump-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 038fc63c2760dc334d9e07a2d934887a5ba210c3d2f786fe0056f0145e9bd2e0
MD5 cdeb3c8e620e70ec48f40c1b22447ca0
BLAKE2b-256 abb318ed4866ffc95dba7bb38a4f5d31ab1f0ec35acc606f49ccccc7f87d729c

See more details on using hashes here.

Provenance

The following attestation bundles were made for changelogbump-0.1.2-py3-none-any.whl:

Publisher: python-publish.yml on muad-dweeb/ChangelogBump

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page