通过 
搜索
搜索akrabat / changelog-generator
从GitHub里程碑生成Markdown变更日志
3.0.0
2021-08-12 15:05 UTC
Requires
- php: ^7.3 || ^8.0
- ext-curl: *
- ext-json: *
Replaces
README
此项目提供了一个简单的方法，从GitHub里程碑创建一个按顺序排列的问题和已关闭的pull请求的Markdown列表。
脚本确保删除任何可能破坏生成的链接的特殊字符，并用相应的HTML实体替换；因此，脚本通常可以在无人看管的情况下使用。
这是一个基于 phly/changelog-generator 的分支，用于使用更新的PHP版本以及各种生活质量的改进。
安装
使用 Composer 安装依赖项
$ composer require akrabat/changelog-generator
这将安装脚本到 vendor/bin/changelog_generator.php。
您也可以全局安装
composer global require akrabat/changelog-generator
并确保 ~/.composer/vendor/bin 在您的PATH中。然后可以使用 changelog_generator.php 直接使用脚本。
使用方法
有两种主要方式使用生成器
- 使用CLI选项传入配置
- 创建一个配置文件，并将该文件传递给脚本
标准的CLI选项有
- -t 或 --token，传入您的GitHub API token
- -u 或 --user，传入您的GitHub用户名或组织
- -r 或 --repo，传入您的GitHub仓库名称
- -m 或 --milestone，传入要生成变更日志的GitHub里程碑标识符
例如
vendor/bin/changelog_generator.php -t MYgithubAPItoken -u weierophinney -r changelog_generator -m 1 > changelog.md
或者，创建一个配置文件。您可以使用 config/config.php.dist 作为模板；它只需要返回一个包含键 "token"、"user"、"repo" 和 "milestone" 的数组。然后您将此传递给脚本
vendor/bin/changelog_generator.php -c path/to/config.php
您还可以混合使用选项 -- 例如，您可能将token放置在配置文件中，然后通过CLI传递其他选项。
附加选项
附加CLI选项控制输出
- -g 或 --group-labels，按标签显示结果
- -o 或 --plain-text-output，将里程碑标题显示为纯文本，而不是HTML编码