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.1.tar.gz (4.5 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.1-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: changelogbump-0.1.1.tar.gz
  • Upload date:
  • Size: 4.5 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.1.tar.gz
Algorithm Hash digest
SHA256 f0e87adba75a0f9cc8569b7865bab033a901256de2fcacd5f20eda64762f5bf9
MD5 8f6294d4df406126e826ce93d37fbadd
BLAKE2b-256 553a5ddd6486d3eff5fc84740174d04739f30be7412ab57c6f555407bde075a8

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: changelogbump-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 62a8a1b141a4361071ae09002f9a0c40b9b7363c44efc091312e3ff569753c49
MD5 cdccee6969c9572fc73dd4c6823cdf86
BLAKE2b-256 0d3f99608d16da728aab9b432909ae01687a83e48d9b0c64a3605217ea04ac28

See more details on using hashes here.

Provenance

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