drewcassidy/yaclog
1
0
Fork 0
mirror of https://github.com/drewcassidy/yaclog.git synced 2024-06-11 01:07:25 +00:00
Code Issues Projects Releases Wiki Activity
106 Commits 2 Branches 14 Tags 277 KiB
Python 100%
1.0.3
Go to file
drewcassidy dccde1909b Release Version 1.0.3 
### Fixed

- Fixed `show` command not working with Click version 8
- Fixed release message incorrectly stating if a commit will be created or not
2021-05-11 22:27:07 -07:00
.github/workflows Run tests with multiple versions of click 2021-05-11 22:21:09 -07:00
docs Update docs 2021-05-11 19:12:31 -07:00
tests Fix show command 2021-05-11 22:10:13 -07:00
yaclog Fix release messages 2021-05-11 22:13:50 -07:00
.gitignore Ignore .idea 2021-04-12 22:44:20 -07:00
.readthedocs.yaml Add epub builds 2021-05-07 01:16:20 -07:00
CHANGELOG.md Release Version 1.0.3 2021-05-11 22:27:07 -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 Use regex for parsing 2021-04-16 21:43:10 -07:00
README.md Version 1.0.0 2021-05-07 14:52:28 -07:00
setup.cfg Update to support Click 8 2021-05-11 19:04:31 -07:00

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