https://github.com/thememium/usechange
useChange is a Python CLI that generates changelogs and release notes from Conventional Commits, with semver bumping and GitHub release sync.
https://github.com/thememium/usechange
github python release release-automation
Last synced: 14 days ago
JSON representation
useChange is a Python CLI that generates changelogs and release notes from Conventional Commits, with semver bumping and GitHub release sync.
- Host: GitHub
- URL: https://github.com/thememium/usechange
- Owner: thememium
- License: mit
- Created: 2026-02-15T05:06:46.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2026-06-13T04:56:24.000Z (14 days ago)
- Last Synced: 2026-06-13T05:17:34.787Z (14 days ago)
- Topics: github, python, release, release-automation
- Language: Python
- Homepage:
- Size: 693 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Table of Contents
## 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.
## 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)
```sh
uv add usechange
```
### Install with pip (alternative)
```sh
pip install usechange
```
### Generate a changelog
```sh
change log --write
```
### Interactive release workflow
```sh
change release
```
### Sync the latest release to GitHub
```sh
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 , for multi-selection and to accept
```
## Usage
### Generate changelog
```sh
change log --from v0.1.0 --to HEAD --output CHANGELOG.md
```
### Version bumping
```sh
change log --bump --write
change log --major --write
```
### Release workflow
```sh
change release --yes
```
### GitHub release sync
```sh
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]
## Development
Common tasks:
```sh
uv run poe test
uv run poe lint
uv run poe format
uv run poe typecheck
uv run poe clean-full
```
## 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
## License
License not yet specified in this repository.
---
