Project

chlog

0.0
The project is in a healthy, maintained state
chlogccmywish/chlogHomepageDocumentationSource CodeBug TrackerWiki
This command line tool `chlog` helps generate and maintain the Changelog of your projects.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 Popularity
Downloads
7,205
Stars
2
Forks
0
Watchers
1
 Releases
Current version
0.8.1
Total releases
1
First release
2023-02-12
Latest release
2023-02-12
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2022-07-25
Reverse Dependencies
0

 Dependencies

Runtime

highline
~> 2.0
 Project Readme

chlog

Gem Version

gem install chlog

Easily maintain Changelog on the cli.


What a good Changelog looks like?

See what a good Changelog chlog can help to generate all through command line without your editing.

See how chlog help to maintain its own Changelog.


Why?

See why I made this project rather than use existing tool from CHANGELOG.md Initialize part.

See why you should keep a changelog.


Usage

Notice:

  1. You can always manually add/change info to your Changelog.
  2. The log's category order is keep.
chlog (v#{Chlog::GEM_VERSION}): Help maintain the Changelog of your projects

Usage:

  chlog -g                Generate CHANGELOG.md in git root
  chlog -r <3.14>         Release version to v3.14

Add log:

  chlog <-main category> [--sub category] <log>

Main Category:

  -n    Add log to New features
  -e    Add log to Enhancements
  -b    Add log to Bug fixes
  -s    Add log to Security
  -c    Add log to Compatibility
  -d    Add log to Deprecations