sebastiaanluca / laravel-changelog
此包已被废弃且不再维护。未建议替代包。
在您的应用程序中显示项目变更日志
1.0.0
2021-03-10 17:22 UTC
Requires
- php: ^8.0
- erusev/parsedown: ^1.7.4
- laravel/framework: ^8.0
Requires (Dev)
- mockery/mockery: ^1.4.3
- orchestra/testbench: ^6.4
- phpunit/phpunit: ^9.5.2
This package is auto-updated.
Last update: 2022-03-07 15:06:44 UTC
README
在您的应用程序中显示项目解析后的Markdown变更日志。
要求
- PHP 8 或更高版本
- Laravel 8 或更高版本
需要支持更早版本?尝试任何之前的包版本。
如何使用
确保您的项目根目录中有一个 CHANGELOG.md
文件。
其次,通过在主路由文件中调用相应的方法来注册路由
\SebastiaanLuca\Changelog\Changelog::routes();
这将允许您通过访问 https://example.com/changelog
在浏览器中查看解析后的变更日志。
默认情况下,变更日志被缓存。在部署期间清除缓存是一个好习惯,可以通过运行以下命令来实现:
php artisan cache:clear
其他使用方法
如果您不想使用包的路由,您可以在自己的控制器中获取解析和缓存的变更日志
$changelog = \SebastiaanLuca\Changelog\Changelog::getCachedChangelog();
自定义
要自定义设置,首先发布配置文件,然后打开 config/changelog.php
php artisan vendor:publish --tag="laravel-changelog (configuration)"
在这里,您可以更改日志的位置、路由名称和URL、用于显示日志的视图以及是否以及如何缓存它。
许可
此包在MIT许可证(MIT)下运行。有关更多信息,请参阅LICENSE。
变更日志
有关最近更改的信息,请参阅CHANGELOG。
测试
composer install
composer test
贡献
有关详细信息,请参阅CONTRIBUTING 和 CONDUCT。
安全
如果您发现任何与安全相关的问题,请通过电子邮件hello@sebastiaanluca.com联系,而不是使用问题跟踪器。
鸣谢
关于
我的名字是Sebastiaan,我是一名自由职业的Laravel开发者,专注于构建定制化的Laravel应用程序。查看我的作品集以获取更多信息,我的博客了解最新的技巧和窍门,以及我的其他包,助您启动下一个项目。
您有需要指导的项目吗?请发送邮件至hello@sebastiaanluca.com!