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
358942c858
### Added - Readme file now has installation and usage instructions. - yaclog command entry point added to setup.cfg. ### Changed - `release -c` will no longer create empty commits, and will use the current commit instead. ### Fixed - `release` and `entry` commands now work using empty changelogs. |
3 years ago | |
|---|---|---|
| .github/workflows | 3 years ago | |
| yaclog | 3 years ago | |
| .gitignore | 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 --version 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".