markwalet/laravel-changelog

一个用于防止在您的变更日志文件上出现合并冲突的Laravel包。

v1.10.0 2024-03-13 10:54 UTC

README

MIT Licensed Latest Stable Version Build status Coverage StyleCI Total Downloads

一个用于防止在您的变更日志文件上出现合并冲突的Laravel包。

它允许您通过根据您当前所在的分支存储它们到单独的文件中,来管理您的更改。这确保您不会与其他开发者在同一文件上工作。

安装

您可以使用composer安装此包

composer require markwalet/laravel-changelog

Laravel >=5.5使用包自动发现,因此您无需注册服务提供者。如果您想手动注册服务提供者,请在您的config/app.php文件中添加以下行

MarkWalet\Changelog\ChangelogServiceProvider::class

安装后,验证并更改配置以满足您的特定需求,然后运行php artisan changelog:install。这将创建一个文件夹,其中将存储所有更改。默认为base_path('.changes')

使用方法

此包的主要功能由6个命令组成

  • php artisan changelog:add {--type=} {--message=}(向当前功能条目添加更改)
  • php artisan changelog:list(显示所有版本的更改列表)
  • php artisan changelog:unreleased(显示未发布更改列表)
  • php artisan changelog:current(显示当前分支未发布更改列表)
  • php artisan changelog:release(将所有未发布更改移动到新版本)
  • php artisan changelog:generate {--dry-run} {--path=}(根据您的更改生成markdown文件。路径选项可以为空)

配置

默认配置在changelog.php中定义。如果您想编辑此文件,可以使用以下命令将其复制到您的配置文件夹

php artisan vendor:publish --provider="MarkWalet\Changelog\ChangelogServiceProvider"

当您发布这些供应商资产时,还可以编辑在生成变更日志markdown文件时使用的默认模板。模板文件位于resources/views/vendor/changelog/changelog.blade.php