@greathobbies/changelog-manager NPM

Changelog Manager

This tool allows you to manage a changelog with the use of a changes file and JSON to store changes to be built into a changelog.

Installing is as easy and running:

npm install -g @greathobbies/changelog-manager

First run the init command to initialise the directories and config.

changelog-manager init

This will initialise the .changelog-manager directory, the entry directories and the config file. You can then use the manager as per below.

changelog-manager [command] [options]

Initialises the directories and config.

changelog-manager init [options]

Option	Description	Required

Parses and saves content from changes file to a change json file.

changelog-manager changes add <ID> [options]

Option	Description	Required
ID	Reference value. Typically MR number.	:heavy_check_mark:
--issues	Issue numbers associated with change. Comma separated.	:x:
-r release	The release to add the changes to.	:x:
-i file	The changes file to add changes from.	:x:
-s	Strict mode. Returns an error if there are non standard sections.	:x:

Adds release entry.

changelog-manager releases add <release> [options]

Option	Description	Required
release	Release name. E.g. 1.1.0	:heavy_check_mark:
-d date	Date of release	:x:

Sets a release to a change or all changes with no release.

changelog-manager releases set <release> [options]

Option	Description	Required
release	Release to set change(s) to.	:heavy_check_mark:
-c change	Change to set release to. Don't set to set all changes without a release.	:x:

Removes a release from the changelog json file.

changelog-manager releases remove <release> [options]

Option	Description	Required
release	Release to delete.	:heavy_check_mark:

Builds the changelog from the change JSON files.

changelog-manager build [options]

Option	Description	Required
--header string	Use to replace default header text or set false to leave empty header.	:x:
-o file	Output changelog file.	:x:
-l url	Issue link prefix. Change issues get appended to this.	:x:

Builds and cats the changelog.

changelog-manager cat [options]

Option	Description	Required
-l url	Issue link prefix. Change issues get appended to this.	:x:
-r release	Output specific release.	:x:
--header text	Use to replace default header text or set false to leave empty header.	:x:

The config file is located under the .changelog-manager directory.

Setting	Description	Default
IssuesLink	The prefix link for issues if `-l` isn't set in a command.	""
HeaderContent	The header content that is placed between `Changelog` and the latest release.	All notable changes to this project will be documented in this file. The format is based on Keep a Changelog.