usechange 0.1.17

Generate Beautiful Changelogs using Conventional Commits

Explore the Documentation »
Report Bug · Request Feature

Table of Contents

1. About
2. Quick Start
3. Usage
4. Development
5. Contributing
6. License

About

usechange is a Python CLI for generating changelogs and release notes from Conventional Commits. It reads git history between refs, groups commits by type, renders Markdown release notes, and can update version numbers based on semantic versioning rules.

It gives you:

• Changelog generation - Render release notes and optionally write to CHANGELOG.md.
• Semver bumping - Determine version bumps from commit types and breaking changes.
• Release workflows - Tag and publish using uv and gh.
• GitHub sync - Sync release notes to GitHub releases.
• Repo metadata - Create commit and compare links automatically.

(back to top)

Quick Start

Install usechange with uv (recommended)

uv add usechange

Install with pip (alternative)

pip install usechange

Generate a changelog

usechange changelog --write

Sync the latest release to GitHub

usechange github release

(back to top)

Usage

Generate changelog

usechange changelog --from v0.1.0 --to HEAD --output CHANGELOG.md

Version bumping

usechange changelog --bump --write
usechange changelog --major --write

Release workflow

usechange release --yes

GitHub release sync

usechange github release 0.2.0
usechange github release all

Configuration

usechange reads configuration from one of the following:

• changelog.config.json
• .changelogrc
• changelog.config.toml
• pyproject.toml under [tool.changelog]

(back to top)

Development

Common tasks:

uv run poe test
uv run poe lint
uv run poe format
uv run poe typecheck
uv run poe clean-full

(back to top)

Contributing

Quick workflow:

1. Fork and branch: git checkout -b feature/name
2. Make changes
3. Run checks: uv run poe clean-full
4. Commit and push
5. Open a Pull Request

(back to top)

License

License not yet specified in this repository.

(back to top)

---

_{Built by thememium}