@wyze/clog

A conventional changelog for the rest of us

This is just an npm distribution of the amazing clog with some of my additional changes.

Installation and Requirements

Requirements

Mac

Right now, this package only supports the clog distribution available for Mac. There are other distributions available.

Installation

Install this tool via yarn: $ yarn global add @wyze/clog-cli

Usage

In your terminal, simply type clog --help to get output of the options available.

See the official clog website for documentation on how to use clog.

Here's the output when you type clog --help:

clog 0.9.3
a conventional changelog for the rest of us

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 <FILE>      A previous changelog to prepend new changes to (this is like using the same file for
                                both --infile and --outfile and should not be used in conjuction with either)
    -c, --config <FILE>         The Clog Configuration TOML file to use (Defaults to '.clog.toml')**
    -T, --format <FORMAT>       The output format, defaults to markdown (valid values: markdown, json)
    -f, --from <HASH>           e.g. 12a8546
    -g, --git-dir <PATH>        Local .git directory (defaults to current dir + '.git')*
    -i, --infile <FILE>         A changelog to append to, but *NOT* write to (Useful in conjunction with --outfile)
    -l, --link-style <STYLE>    The style of repository link to generate (Defaults to github) [values: Github, Gitlab,
                                Stash, Cgit]
    -o, --outfile <FILE>        Where to write the changelog (Defaults to stdout when omitted)
    -r, --repository <URL>      Repository used for generating commit and issue links (without the .git, e.g.
                                https://github.com/thoughtram/clog)
        --setdate <DATE>        e.g. 2020-01-01
        --setversion <VER>      e.g. 1.0.1
    -s, --subtitle <TITLE>      e.g. "Crazy Release Title"
    -t, --to <HASH>             e.g. 8057684 (Defaults to HEAD when omitted)
    -w, --work-tree <PATH>      Local working tree of the git project (defaults to current dir)*

* If your .git directory is a child of your project directory (most common, such as /myproject/.git) AND not in the
current working directory (i.e you need to use --work-tree or --git-dir) you only need to specify either the --work-tree
(i.e. /myproject) OR --git-dir (i.e. /myproject/.git), you don't need to use both.

** If using the --config to specify a clog configuration TOML file NOT in the current working directory (meaning you
need to use --work-tree or --git-dir) AND the TOML file is inside your project directory (i.e. /myproject/.clog.toml)
you do not need to use --work-tree or --git-dir.

LICENSE

Both this package and the clog tool itself are MIT licensed.