phly/changelog-generator

从您的GitHub里程碑生成Markdown变更日志

维护者

详细信息

github.com/weierophinney/changelog_generator

源代码

问题

资助包维护！
社区桥梁

安装次数: 12,822

依赖项: 4

建议者: 0

安全: 0

星标: 87

关注者: 3

分支: 10

公开问题: 3

v2.2.0 2017-02-22 20:51 UTC

Requires

BSD-2-Clause 1cecc0fe3e621219598e94341b25785201131083

githubchangelog

This package is auto-updated.

Last update: 2024-09-11 13:50:17 UTC

README

本项目提供了一种简单的方法来创建一个按顺序排列的问题和拉取请求的Markdown列表，这些问题和拉取请求在GitHub的特定里程碑中关闭。它使用Zend Framework的Zend\Http组件与GitHub API通信，并使用Zend\Console\Getopt处理命令行选项解析。

脚本确保任何可能破坏生成的链接的特殊字符都被清除并替换为相应的HTML实体；因此，脚本通常可以在无人值守的情况下使用。

安装

使用 Composer 安装依赖项

php /path/to/composer.phar install

或者，您可以使用Composer将其组合到现有的PHP应用程序中。将以下内容添加到您的 composer.json

{
    "require": {
        "phly/changelog-generator": "*"
    }
}

然后执行 composer.phar install 或 composer.phar update。这将脚本安装到 vendor/bin/changelog_generator.php。

用法

使用生成器有两种主要方式

  • 使用CLI选项传递配置
  • 创建一个配置文件，并将该文件传递给脚本

标准的CLI选项包括

  • -t 或 --token，传递您的GitHub API令牌
  • -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

您还可以混合匹配选项 -- 例如，您可能将令牌放置在配置文件中，然后通过CLI传递其他选项。