changelogbump 0.5.0

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

changelogbump

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.

Requirements

• pyproject.toml

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"
  

• Check the currently installed version of changelogbump:

  changelogbump version
  

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.