Go to file
2024-04-16 00:08:25 -07:00
.github
docs
tests
yaclog
.gitignore
.readthedocs.yaml
CHANGELOG.md
LICENSE.md
logo.png
pyproject.toml
README.md

Yaclog

Documentation Status Build Status PyPI version

Yet another changelog command line tool

a yak who is a log

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