mogic / changelog-helper
A laravel zero application to maintain your CHANGELOG file based on keepachangelog.com
Installs: 5
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Type:project
Requires
- php: ^8.2.0
Requires (Dev)
- laravel-zero/framework: ^11.0.2
- laravel-zero/phar-updater: ^1.4
- laravel/pint: ^1.18.1
- mockery/mockery: ^1.6.12
- pestphp/pest: ^3.5.1
- phlak/semver: ^6.0
- spatie/laravel-package-tools: ^1.17
README
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.