README

Changelog-Helper is a set of commandline utilities for adding and releasing new CHANGELOG.md entries as defined by keepachangelog.com definition.

It helps with the creation of correct entries, version numbers, tags and the table of contents.

Documentation

The helper is built on top of the Laravel Zero components and uses git as an internal command.

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

Build & release new version

To build a new release version, we have to create the build with the release tag to create after.

./changelog-helper app:build changelog-helper --build-version=1.x.x
git add ./builds/changelog-helper
./changelog-helper add added Added new release build
git add ./builds/changelog-helper
git add ./CHANGELOG.md
./changelog-helper release minor 1.x.x
git push && git git push --tags

Author

Changelog-Helper was created by Stefan Berger from MOGIC.

License

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

Tests

run ./vendor/bin/pest

mogic / changelog-helper

Maintainers

Details