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.2.0a0.tar.gz (4.9 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.2.0a0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file changelogbump-0.2.0a0.tar.gz.

File metadata

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

File hashes

Hashes for changelogbump-0.2.0a0.tar.gz
Algorithm Hash digest
SHA256 2c5e1322d9d44cb633573e4bbe1f50e99c84919972f93dd17c3a35b9a9e6a955
MD5 ca88f0b93502f8cc21b0b0193e28b15d
BLAKE2b-256 e48c131ec7582519c1a1a360954db527172f57e52863bf378f975df8fd9ef887

See more details on using hashes here.

Provenance

The following attestation bundles were made for changelogbump-0.2.0a0.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.2.0a0-py3-none-any.whl.

File metadata

File hashes

Hashes for changelogbump-0.2.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9be756f7e7db98cc1b8dd97bbe41ae04bff256424309571ab110e4a5018e2ed
MD5 0ec9a772ef56aa76aa0ae77e454fbf4c
BLAKE2b-256 159c39a87a192e8c009e7fde9ac5d217850f3928266348da7e1b0b24239dd9a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for changelogbump-0.2.0a0-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