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.0.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.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: changelogbump-0.2.0.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.0.tar.gz
Algorithm Hash digest
SHA256 dbc7187308e184d04ed861999760cd0bd09291f0bc0ccdf8af06c76372390833
MD5 b4450ab5da32dbd225423a744a9bd73b
BLAKE2b-256 2ab2d451d863098c5a6406244bfe893427a1135a50a5811d625a5677aa38d7fb

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: changelogbump-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 323033ec11063086cccefda095796362657f8b5e9100e11fe9c3cf4c541e8c6e
MD5 3a637b3d6c523bf56fc443a976cb39b9
BLAKE2b-256 169c80d3699e34ad75b1c1a36537ee07e20ba8a76dc3b40fe343cc7e5fdf7b8d

See more details on using hashes here.

Provenance

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