Download the PHP package lightszentip/laravel-release-changelog-generator without Composer
On this page you can find all versions of the php package lightszentip/laravel-release-changelog-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lightszentip/laravel-release-changelog-generator
More information about lightszentip/laravel-release-changelog-generator
Files in lightszentip/laravel-release-changelog-generator
Package laravel-release-changelog-generator
Short Description Package to create releases and changelogs in laravel
License MIT
Homepage https://github.com/lightszentip/laravel-release-changelog-generator
Informations about the package laravel-release-changelog-generator
Package to create releases and changelogs in laravel
This package add a changelog management over command line and a version release management. So you can add new changelog items and if you release, the changelog ist update with new version and the version file also. So it is easy to manage a customer changelog.
The changelog is a json file that can easy integrate into a controller to present to end customer.
See ROADMAP for new functions.
HINT: Please run 'php artisan vendor:publish --tag=resources'
Version Compatibility
Release Changelog Generator | PHP | Laravel |
---|---|---|
0.1.x | >=8.0 | 9 |
0.2.0 | >=8.0 | 9 |
0.2.1 | >=8.0 | 9 / 10 (not tested) |
0.3.x | >=8.1 | 9 / 10 |
0.4.x | >=8.2 | 11 |
Installation
You can install the package via composer:
Please publish the necessary files with:
Usage
If the command use without arguments, the command line create a ask for all necessary arguments.
Create a new changelog item:
You can find the result in resources/.changes/changelog.json
Release the changelog
This update the version.yml to the next patch vesion and add in the changelog.json a new release with all current changelog items.
Update CHANGELOG.md file:
This will update the CHANGELOG.md file in the root with your changes.
Get version in the application
Blade
To get a special format for the version, you find in the 'releasechangelog.php' in the config dir the item ' version_formats'. You can add new formats and/or change the existing. To use it:
Code
Config
` set to false to remove the "rc" part from version
To use antother pre release name as 'rc', change it on version.yml direct.
Example Result
version.yml
changelog.json
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Lightszentip
- All Contributors
License
The MIT License (MIT). Please see License File for more information.