README

Show your project's parsed Markdown changelog in your application.

Requirements

PHP 8 or higher
Laravel 8 or higher

Looking for support for earlier versions? Try out any of the previous package versions.

How to use

Ensure you have a CHANGELOG.md file in the root of your project.

Secondly, register the routes by calling the appropriate method in your main routes file:

\SebastiaanLuca\Changelog\Changelog::routes();

This will enable you to visit the parsed changelog in your browser by visiting https://example.com/changelog.

By default, the changelog is cached. A good practice is to clear the cache during deployment by running:

php artisan cache:clear

Alternative use

If you don't wish to use the package's routing, you can get the parsed and cached changelog in your own controller:

$changelog = \SebastiaanLuca\Changelog\Changelog::getCachedChangelog();

Customization

To customize a setting, first publish the configuration file and open config/changelog.php:

php artisan vendor:publish --tag="laravel-changelog (configuration)"

Here you can change the location of the log, the route name and URL, the view used to display the log, and if and how you want to cache it.

License

This package operates under the MIT License (MIT). Please see LICENSE for more information.

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

composer install
composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email hello@sebastiaanluca.com instead of using the issue tracker.

Credits

About

My name is Sebastiaan and I'm a freelance Laravel developer specializing in building custom Laravel applications. Check out my portfolio for more information, my blog for the latest tips and tricks, and my other packages to kick-start your next project.

Have a project that could use some guidance? Send me an e-mail at hello@sebastiaanluca.com!

sebastiaanluca / laravel-changelog

Maintainers

Details