usechange 0.1.23

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

usechange provides a short alias and command shortcuts:

• usechange and change are equivalent.
• changelog also supports the log alias.

Install usechange with uv (recommended)

uv add usechange

Install with pip (alternative)

pip install usechange

Generate a changelog

change log --write

Interactive release workflow

change release

Sync the latest release to GitHub

change github release

Interactive changelog preview

Example prompt for selecting optional changelog flags:

Select optional flags (space to select, enter to confirm):
> [ ] --from - Start commit reference
  [ ] --to - End commit reference
  [ ] --dir - Path to a git repository
  [ ] --clean [bool] - Ensure working directory is clean
  [ ] --output - Changelog file to write
  [ ] --write [bool] - Write changelog to CHANGELOG.md
  [ ] --no-output [bool] - Do not write a changelog file
  [ ] --noAuthors [bool] - Skip contributors section
  [ ] --noDate [bool] - Omit date from header
  [ ] --noEmojis [bool] - Omit emojis from headers
  [ ] --hideAuthorEmail [bool] - Hide author email if no username is found
  [ ] --bump [bool] - Determine and update version
  [ ] -r - Release as a specific version
  [ ] --release [bool] - Bump, tag, and release
  [ ] --no-commit [bool] - Skip release commit
  [ ] --no-tag [bool] - Skip release tag
  [ ] --push [bool] - Push commits and tags
  [ ] --no-github [bool] - Skip GitHub release sync
  [ ] --publish [bool] - Publish after generating
  [ ] --publishTag - Publish with a custom tag
  [ ] --nameSuffix - Append suffix to package name
  [ ] --versionSuffix - Append suffix to version
  [ ] --canary - Shortcut for --bump and --versionSuffix
  [ ] --major [bool] - Force major bump
  [ ] --minor [bool] - Force minor bump
  [ ] --patch [bool] - Force patch bump
  [ ] --premajor - Force premajor bump
  [ ] --preminor - Force preminor bump
  [ ] --prepatch - Force prepatch bump
  [ ] --prerelease - Force prerelease bump
Press <space>, <tab> for multi-selection and <enter> to accept

(back to top)

Usage

Generate changelog

change log --from v0.1.0 --to HEAD --output CHANGELOG.md

Version bumping

change log --bump --write
change log --major --write

Release workflow

change release --yes

GitHub release sync

change github release 0.2.0
change gh 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}