guywithnose / release-notes
用于构建基于GitHub项目的发布说明的脚本。
v1.1.3
2020-03-09 17:32 UTC
Requires
- php: ~7.0
- clue/graph: ~0.9.0
- flexyproject/githubapi: ~1.0
- gregwar/cache: ~1.0
- herrera-io/version: ~1.1
- lesstif/php-jira-rest-client: ^1.7.0
- nubs/random-name-generator: ~0.1.0
- nubs/sensible: ~0.5.0
- nubs/which: ~1.0
- symfony/console: ~3.0
- symfony/process: ~3.0
Requires (Dev)
- phpunit/phpunit: ~6.0
- squizlabs/php_codesniffer: ~2.6
- traderinteractive/coding-standard: 2.1.0
This package is auto-updated.
Last update: 2024-09-07 11:10:03 UTC
README
查看GitHub仓库上的提交,并使用自上次标签以来的提交生成发布说明。
基本用法
发布说明需要指定组织或用户名和仓库名。然后它会处理提交以构建指定仓库的发布说明和标签。您将收到多个选项来更改输出并确定标签的生成方式。
$ bin/buildRelease organization-name repo-name
有许多命令行参数选项可以指定,以允许工具在用户几乎不与交互的情况下运行。所有选项都可以通过运行带有--help
命令查看。
$ bin/buildRelease --help
GitHub集成
GitHub集成使用个人访问令牌。当您第一次运行工具时,将请求此令牌,或者您可以使用--access-token
参数选项在命令行上提供信息。
如果您在工具的提示处提供令牌,它将此令牌存储在.access_token
文件中。您可以使用--token-file
参数选项指定不同的访问令牌文件。此文件的默认位置可以通过--cache-dir
参数选项更改。
如果您希望使用不同的API版本或私有GitHub Enterprise服务器使用此工具,则可以使用--github-api
参数选项更改工具用于API调用的基础URL。
Jira集成
Jira集成目前需要您创建一个包含您访问Jira的服务器URL、用户名和密码的.env文件。
首先将.env.dist复制到.env,并使用您的信息进行修改。
使用--jira-types
和--jira-lookup
参数选项将尝试在用于生成说明的提交消息中查找Jira问题编号,然后查询服务器。