@greathobbies/changelog-manager

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.

Installation

Installing is as easy and running:

npm install -g @greathobbies/changelog-manager

Usage

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]

Commands

init

Initialises the directories and config.

changelog-manager init [options]

Option	Description	Required

changes add

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.	✔️
--issues	Issue numbers associated with change. Comma separated.	❌
-r [release]	The release to add the changes to.	❌
-i [file]	The changes file to add changes from.	❌
-s	Strict mode. Returns an error if there are non standard sections.	❌

releases add

Adds release entry.

changelog-manager releases add <release> [options]

Option	Description	Required
release	Release name. E.g. 1.1.0	✔️
-d [date]	Date of release	❌

releases set

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.	✔️
-c [change]	Change to set release to. Don't set to set all changes without a release.	❌

releases remove

Removes a release from the changelog json file.

changelog-manager releases remove <release> [options]

Option	Description	Required
release	Release to delete.	✔️

build

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.	❌
-o [file]	Output changelog file.	❌
-l [url]	Issue link prefix. Change issues get appended to this.	❌

cat

Builds and cats the changelog.

changelog-manager cat [options]

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

Config

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.