drewcassidy
/
yaclog
mirror of https://github.com/drewcassidy/yaclog.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
129 Commits
2 Branches
14 Tags
277 KiB
Python 100%
 
main
dev
1.2.0
1.1.2
1.1.1
1.1.0
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.3.3
0.3.2
0.3.1
0.2.0
0.1.0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '396960fae0'
${ noResults }
Go to file
Andrew Cassidy 396960fae0 Only import toml and gitpython when necessary 
Allows for using most commands on platforms without git installed (like the a-shell app on ios where gitpython doesnt quite work)
 		1 year ago
.github Bump actions/setup-python from 4.2.0 to 4.3.1 1 year ago
docs Update docs 3 years ago
tests Add cargo.toml support 2 years ago
yaclog Only import toml and gitpython when necessary 1 year ago
.gitignore Ignore .idea 3 years ago
.readthedocs.yaml Add epub builds 3 years ago
CHANGELOG.md Release Version 1.1.1 2 years ago
LICENSE.md Make license markdown 3 years ago
README.md Version 1.0.0 3 years ago
logo.png Add logo 3 years ago
pyproject.toml Add cargo.toml support 2 years ago

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