Go to file
2024-04-16 00:08:25 -07:00
.github Update CI workflow some more 2024-04-16 00:03:35 -07:00
docs Update docs 2021-05-11 19:12:31 -07:00
tests Add -s, -n, and -y options to release 2024-04-15 23:45:24 -07:00
yaclog also make -y apply to git commit confirmations 2024-04-15 23:49:14 -07:00
.gitignore Ignore .idea 2021-04-12 22:44:20 -07:00
.readthedocs.yaml Readthedocs broke their dang config schema? 2024-04-16 00:08:25 -07:00
CHANGELOG.md Release Version 1.2.0 2024-04-15 23:49:30 -07:00
LICENSE.md Make license markdown 2021-04-12 22:43:09 -07:00
logo.png Add logo 2021-04-18 16:57:55 -07:00
pyproject.toml Add cargo.toml support 2022-08-13 20:02:45 -07:00
README.md Version 1.0.0 2021-05-07 14:52:28 -07:00


Documentation Status Build Status PyPI version

Yet another changelog command line tool

a yak who is a log

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.

  --path FILE  Location of the changelog file.  [default: CHANGELOG.md]
  --version    Show the version and exit.
  --help       Show this message and exit.

  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

- 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".