You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Yaclog
1.4.2
Yet another changelog command line tool
Logo by Erin Cassidy
Install and update using pip:
$ pip install -U yaclog
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
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".