You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Andrew Cassidy
66bc8509e3
### Changed - API changes: - `header` attribute renamed to `preamble` to avoid confusion. - improved version header parsing to be more robust and handle multi-word version names. - improved version number incrementing in `release`. - can now handle other text surrounding a pep440-compliant version number, which will not be modified - can now handle pre-releases correctly. The version to increment is the most recent version in the log with a valid pep440 version number in it. - Release increment and prerelease increments can be mixed, allowing e.g: `yaclog release -mr` to create a release candidate with in incremented minor version number. - `release` base version is now an argument instead of an option, for consistency with other commands. ### Removed - `entry` with multiple `-b` options no longer add sub bullet points, instead adding each bullet as its own line. ### Added - Terminal output has color to distinguish version names/headers, sections, and git information. - Extra newlines are added between versions to improve readability of the raw markdown file. |
3 years ago | |
---|---|---|
.github/workflows | 3 years ago | |
docs | 3 years ago | |
tests | 3 years ago | |
yaclog | 3 years ago | |
.gitignore | 3 years ago | |
.readthedocs.yaml | 3 years ago | |
CHANGELOG.md | 3 years ago | |
LICENSE.md | 3 years ago | |
README.md | 3 years ago | |
logo.png | 3 years ago | |
pyproject.toml | 3 years ago | |
setup.cfg | 3 years ago |
README.md
Yaclog
Yet another changelog command line tool
Logo by Erin Cassidy
Installation
Install and update using pip:
$ pip install -U yaclog
Usage
For usage from the command line, yaclog provides the yaclog
command:
Usage: yaclog [OPTIONS] COMMAND [ARGS]...
Manipulate markdown changelog files.
Options:
--path FILE Location of the changelog file. [default: CHANGELOG.md]
--version Show the version and exit.
--help Show this message and exit.
Commands:
entry Add entries to the changelog.
format Reformat the changelog file.
init Create a new changelog file.
release Release versions.
show Show changes from the changelog file
tag Modify version tags
Example workflow
Create a new changelog:
$ yaclog init
Add some new entries to the "Added" section of the current unreleased version:
$ yaclog entry -b 'Introduced some more bugs'
$ yaclog entry -b 'Introduced some more features'
Show the current version:
$ yaclog show
Unreleased
- Introduced some more bugs
- Introduced some more features
Release the current version and make a git tag for it
$ yaclog release 0.0.1 -c
Renamed version "Unreleased" to "0.0.1".
Commit and create tag for version 0.0.1? [y/N]: y
Created commit a7b6789
Created tag "0.0.1".