README

此包添加了通过命令行进行变更日志管理和版本发布管理的功能。因此，您可以添加新的变更日志项，如果发布，则变更日志会更新为新版本，版本文件也会更新。因此，可以轻松管理客户变更日志。

变更日志是一个json文件，可以轻松集成到控制器中，以向最终用户展示。

查看路线图了解新功能。

提示：请运行 'php artisan vendor:publish --tag=resources'

版本兼容性

安装

您可以通过composer安装此包

composer require lightszentip/laravel-release-changelog-generator

请使用以下命令发布必要的文件

php artisan vendor:publish --provider="Lightszentip\LaravelReleaseChangelogGenerator\ServiceProvider"
php artisan vendor:publish --tag=resources

用法

如果命令未使用参数，命令行会询问所有必要的参数。

创建新的变更日志项

php artisan changelog:add --type="feat" --message="Implement the whole function for magic"

您可以在 resources/.changes/changelog.json 中找到结果。

发布变更日志

php artisan changelog:release --releasename="My First Release" --type=patch

这将更新 version.yml 到下一个补丁版本，并在 changelog.json 中添加一个包含所有当前变更日志项的新发布。

更新 CHANGELOG.md 文件

这将更新根目录中的 CHANGELOG.md 文件，以反映您的更改。

php artisan changelog:generate-md

获取应用程序中的版本

Blade

@releasechangelog

要获取特殊格式的版本，您可以在配置目录中的 'releasechangelog.php' 文件中找到 'version_formats' 项。您可以添加新格式或更改现有格式。要使用它

@releasechangelog('full')

代码

app('releasechangelog.version')->showVersion($format)

配置

prerelease 设置为 false 以从版本中移除 "rc" 部分

要将另一个预发布名称作为 'rc' 使用，请在 version.yml 中直接更改它。

示例结果

version.yml

label: v
major: 1
minor: 0
patch: 1
prerelease: rc
prereleasenumber: 0
buildmetadata: null
timestamp:
    date: null
    timestamp: null

changelog.json

{"unreleased":{"name":"tbd","date":"","release":false},
"1.0.1.rc0":{"name":"My First Release","date":"2022-12-22 23:56:34","release":true,"feat":[{"message":"My first feature"},{"message":"Implement the whole function for magic"}]}}

测试

composer test

变更日志

请参阅变更日志了解最近更改的详细信息。

贡献

请参阅贡献指南了解详情。

安全漏洞

请参阅我们的安全策略了解如何报告安全漏洞。

鸣谢

许可证

MIT 许可证 (MIT)。请参阅许可证文件了解更多信息。

lightszentip / laravel-release-changelog-generator

维护者

详情