phly/keep-a-changelog

Tag and release packages on GitHub using Keep A Changelog; add new version entries to your changelog.

2.2.0 2019-12-03 22:28 UTC

README

Build Status Coverage Status

This project provides tooling support for working with Keep A Changelog.

Installation

Run the following to install this library:

$ composer require phly/keep-a-changelog

Alternately, install globally, for use with any repository:

$ composer global require phly/keep-a-changelog

If you install globally, ensure you add global composer vendor binaries directory to your $PATH environment variable. You can get its location with following command:

$ composer global config bin-dir --absolute

Once setup this way, you can call keep-a-changelog instead of ./vendor/bin/keep-a-changelog.

Usage

You may get a list of commands by running:

$ ./vendor/bin/keep-a-changelog

From there, you can get help for individual commands using:

$ ./vendor/bin/keep-a-changelog help <command>

For more information, please visit the documentation.