lerouse / laravel-change-control
Laravel change control/version management package.
Installs: 5 012
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 0
Requires
- php: ^8.0|^8.1|^8.2
- illuminate/console: ^8.0|^v9.0|^10.0
- illuminate/support: ^8.0|^v9.0|^10.0
Requires (Dev)
- orchestra/testbench: ^6.0
- phpunit/phpunit: ^9.0
README
Laravel change control/version management package.
Installation
The recommended method to install LaravelChangeControl is with composer
php composer require lerouse/laravel-change-control
Laravel without auto-discovery
If you don't use auto-discovery, add the ServiceProvider to the providers array in config/app.php
\Lerouse\LaravelChangeControl\LaravelChangeControlServiceProvider::class,
Package configuration
Copy the package configuration to your local config directory.
php artisan vendor:publish --tag=change-control-config
Usage
Changelog Setup
To use the repository create a changelog.md
file located in the root of your Laravel project.
Add change/version information to the newly created changelog.md
file in the following format:-
## v2.1.3 + Second PATCH release ## v2.1.0 + Second MINOR release ## v2.0.1 + First PATCH release ## v2.0.0 + Second MAJOR release ## v1.0.0 + First MAJOR release ## v0.1.0 + Initial pre-release
Version Helper
Access the version object using the version helper:-
$version = version();
To display the latest changelog version use the version helper:-
// outputs v2.1.3 (from the above changelog example) $version = version()->get();
Return the full changelog:-
// outputs the full changelog as a plain string $version = version()->changelog();
License
Laravel Change Control is free software distributed under the terms of the MIT license.