Changelog-Helper

Changelog-Helper was created by Stefan Berger from MOGIC, and is a set of commandline commands to add new CHANGELOG entries and create new releases.

• Built on top of the Laravel Zero components.

---

Documentation

Install

Via Composer

composer global require mogic/changelog-helper

To get a link index in your CHANGELOG, you have to set a env variable. Add it in your .env or set it global:

CHANGELOG_UNRELEASED_LINK=https://github.com/mogic-le/changelog-helper/compare/develop...main

Usage of commands

Add entry

You can run a one-liner using the add command:

changelog-helper add [added,changed,deprecated,fixed,...] This is a new entry line

Or you can use the same command in a interactive mode:

changelog-helper add

Add entry based on commits

You can use the same command in a interactive mode:

changelog-helper add-commit

Add new release

The release command creates a new release, based on your optional unreleased changes.

Optional: it commits the CHANGELOG.md changes and creates a tag on top of the last commit.

You can use run a one-liner:

changelog-helper release [major|minor|patch] 1|0

Or you can use the same command in a interactive mode:

changelog-helper release

Environmet variables

• CHANGELOG_RELEASE_MESSAGE

License

Changelog-Helper is an open-source software licensed under the MIT license.