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.2a0.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.2a0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: changelogbump-0.1.2a0.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.2a0.tar.gz
Algorithm Hash digest
SHA256 3d67948f389380dc5a67db4fab7816e18f711e87c34f38b3b04ac21708b61873
MD5 b7f169b9027d9a39114133c5ce88d9c3
BLAKE2b-256 8c7762a5c0b0a9631601154fd1abb3018b1ca39cd96fd9a6d2157f9bfd3511d3

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for changelogbump-0.1.2a0-py3-none-any.whl
Algorithm Hash digest
SHA256 6bc0d54744ca16ffbd2854d9a00622ac8c6551d0404edbb4f80ebddc2181661a
MD5 363c8e5ba13b3ab960155f6e2bcc0c35
BLAKE2b-256 13a1496fc5f1dd43a61ff3fc4387b3ea2b7af34a7e288962c20fbf46747a0991

See more details on using hashes here.

Provenance

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