README

史上最小的GitHub ChangeLog生成器！

关于

我写这个工具的原因是我找不到任何满足我需求的GitHub变更日志生成器，我的需求非常简单。

我想生成一个列表，列出特定里程碑中修复的bug和实现的增强功能，以便我可以轻松地将它添加到我们主要产品的CHANGELOG.md文件中。虽然有一些非常好的变更日志生成器，但它们都有一些问题，通常是因为它们扫描了存储库中的每个ticket、里程碑和pull request，如果存储库非常大，包含数千个ticket，这会导致你迅速达到GitHub每小时5000次请求的限制。

这个小工具会获取里程碑的名称，搜索它，获取该里程碑中的所有issue，并将它们分类为bug（如果issue有一个名为"bug"的标签）或增强（如果issue有一个名为"enhancement"的标签）。

带有名为"skip-changelog"标签的issue不会被包括在内。目前只支持打印到屏幕或保存到新文件。待办事项列表中包括自动将变更日志添加到现有文件，并设置标题。

Usage:

    -m, --milestone=<String>
            The milestone

    -f, --file=<String>
            The file to write the changelog to. Defaults to STDOUT

    -p, --prepend
            Prepend the changelog to the file given with --file [NOT IMPLEMENTED YET]

    -t, --token=<string>
            GitHub access token

    -u, --user=<string>
            The user or GitHub organisation

    -r, --repository=<string>
            The repository name

    --title=<string>
            The title of the changelog file. Defaults to "Change Log" [NOT IMPLEMENTED
            YET]

    -h, --help
            Show this help

    -v, --verbose
            Be verbose

necorasystems / ghcl

维护者

详情

README

关于