A conventional changelog for the rest of us
clog creates a changelog automatically from your local git metadata. See the clogs changelog.md for an example.
The way this works, is every time you make a commit, you ensure your commit subject line follows the conventional format. Then when you wish to update your changelog, you simply run clog inside your local repository with any options you'd like to specify.
NOTE: clog also supports empty components by making commit messages such as alias: message or alias(): message (i.e. without the component)
There are two ways to use clog, as a binary via the command line or as a library in your applicaitons via clog-lib.
In order to use clog via the command line you must first obtain a binary by either compiling it yourself, or downlading and installing one of the precompiled binaries.
Follow these instructions to compile clog, then skip down to Installation.
cargo and Rust installed$ git clone https://github.com/clog-tool/clog-cli && cd clog-cli$ cargo build --releasetarget/release/clogThere are several precompiled binaries readily availbe. Browse to http://wod.twentyfives.net/bin/clog/ and download the latest binary for your particular OS. Once you download and extract the tar file (or zip for Windows), the binary will be located at bin/clog
Note: The Mac distribution is available on npm via clog-cli.
Once you have downloaded, or compiled, clog you simply need to place the binary somewhere in your $PATH. If you are not familiar with $PATH read-on; otherwise skip down to Using clog.
You can use clog-bin from the AUR, or follow the instructions for Linux / OS X
You have two options, place clog into a directory that is already located in your $PATH variable (To see which directories those are, open a terminal and type echo "${PATH//:/\n}", the quotation marks are important), or you can add a custom directory to your $PATH
Option 1
If you have write permission to a directory listed in your $PATH or you have root permission (or via sudo), simply copy the clog to that directory # sudo cp clog /usr/local/bin
Option 2
If you do not have root, sudo, or write permission to any directory already in $PATH you can create a directory inside your home directory, and add that. Many people use $HOME/.bin to keep it hidden (and not clutter your home directory), or $HOME/bin if you want it to be always visible. Here is an example to make the directory, add it to $PATH, and copy clog there.
Simply change bin to whatever you'd like to name the directory, and .bashrc to whatever your shell startup file is (usually .bashrc, .bash_profile, or .zshrc)
sh
$ mkdir ~/bin
$ echo "export PATH=$PATH:$HOME/bin" >> ~/.bashrc
$ cp clog ~/bin
$ source ~/.bashrc
On Windows 7/8 you can add directory to the PATH variable by opening a command line as an administrator and running
sh
C:\> setx path "%path%;C:\path\to\clog\binary"
Otherwise, ensure you have the clog binary in the directory which you operating in the command line from, because Windows automatically adds your current directory to PATH (i.e. if you open a command line to C:\my_project\ to use clog ensure clog.exe is inside that directory as well).
clog works by reading your git metadata and specially crafted commit messages and subjects to create a changelog. clog has the following options availble.
```sh USAGE: clog [FLAGS] [OPTIONS]
FLAGS: -F, --from-latest-tag use latest tag as start (instead of --from) -h, --help Prints help information -M, --major Increment major version by one (Sets minor and patch to 0) -m, --minor Increment minor version by one (Sets patch to 0) -p, --patch Increment patch version by one -V, --version Prints version information
OPTIONS:
-C, --changelog