salient / 变更日志
从 GitHub 发布说明生成变更日志,如果需要,合并和去重多个仓库的条目
v1.0.7
2024-09-13 05:20 UTC
Requires
- php: >=7.4
- salient/cache: ^0.99
- salient/cli: ^0.99
- salient/console: ^0.99
- salient/core: ^0.99
- salient/curler: ^0.99
- salient/http: ^0.99
- salient/utils: ^0.99
Requires (Dev)
README
基于 GitHub 发布说明生成变更日志,根据 Keep a Changelog,如果需要,合并和去重多个仓库的条目。
安装
changelog
以 PHP 归档的形式分发,您可以下载并运行
wget -O changelog.phar https://github.com/salient-labs/changelog/releases/latest/download/changelog.phar
php changelog.phar --version
也支持使用 PHIVE 进行安装
phive install salient-labs/changelog
./tools/changelog --version
不建议将 salient/changelog
添加到您的项目作为 Composer 依赖项。
用法
有关详细用法信息,请参阅 用法 或运行
./tools/changelog --help
示例
为仓库中的每个发布生成变更日志
./tools/changelog salient-labs/toolkit
为匹配正则表达式的发布生成变更日志
./tools/changelog --include '/^v0\.20\./' salient-labs/toolkit
为两个标签之间的发布生成变更日志
./tools/changelog --from v0.20.55 --to v0.20.56 salient-labs/toolkit
## [v0.20.56] - 2023-09-06 ### Deprecated - Deprecate `Convert::lineEndingsToUnix()` ### Fixed - Fix regression in `File::getEol()` ## [v0.20.55] - 2023-09-06 ### Changed - Add `Str::setEol()` and standardise `getEol()` methods [v0.20.56]: https://github.com/salient-labs/toolkit/compare/v0.20.55...v0.20.56 [v0.20.55]: https://github.com/salient-labs/toolkit/releases/tag/v0.20.55
将两个仓库的发布说明合并到一个列表中,报告第一个仓库中缺失的发布,并更新 CHANGELOG.md
(用于 CI 工作流生成 此变更日志)
./tools/changelog \ --releases=yes --releases=yes \ --missing=yes --missing=no \ --name "pretty-php for Visual Studio Code" --name "pretty-php" \ --output "CHANGELOG.md" \ --merge \ lkrms/vscode-pretty-php lkrms/pretty-php
许可
本项目采用 MIT 许可 许可。