drewcassidy/yaclog
1
0
Fork 0
mirror of https://github.com/drewcassidy/yaclog.git synced 2024-09-01 14:58:58 +00:00
Code Issues Projects Releases Wiki Activity
57 Commits 3 Branches 19 Tags 393 KiB
Python 100%
f56038d3c9
Go to file
drewcassidy f56038d3c9 Version 0.3.3 
### Added

- Unit tests in the `tests` folder

### Changed

- Default links and dates in VersionEntry are now consistently `None`
- Changelog links dict now contains version links. 
  Modified version links will overwrite those in the table when writing to a file
- Changelog object no longer errors when creating without a path.
- `release` now resets lesser version values when incrementing
- `release` now works with logs that have only unreleased changes
2021-04-26 19:53:50 -07:00
.github/workflows More CLI tests 2021-04-25 22:47:55 -07:00
tests Tests cleanup 2021-04-26 19:53:28 -07:00
yaclog Attempt to fix tagging error? 2021-04-25 22:59:13 -07:00
.gitignore Ignore .idea 2021-04-12 22:44:20 -07:00
CHANGELOG.md Version 0.3.3 2021-04-26 19:53:50 -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 Bug fixes and readme 2021-04-24 02:58:59 -07:00
setup.cfg Add unit tests for parser 2021-04-25 02:16:19 -07:00

README.md

Yaclog

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