googleapis/release-please 可以在根据 Conventional Commit messages 格式的 git commit 生成 changelog 的同时,更新版本号,生成 github pull request
,打 tag 以及 GitHub release 为一体的工具。它与 github 强绑定,属于 GitHub 工作流工具。
使用准备
配置 github token 以及相关权限
github Action 中,可以使用 secret.GITHUB_TOKEN
,需要配置 github token 的 contents
和pull-request
的写权限。
github Action
在实际使用中,由于 cli 操作过于繁琐(每次都需附带 token 和 repo url),建议使用 GitHub Action 进行自动化操作。
> 注意:使用 GitHub 提供给 Action 的 github.token 时,Action 的所有操作,都无法触发其他的 Action。
因此如果想触发其他的 workflow 需要使用 PAT。 fine-grained PAT 需要提供 Contents
和 pull requests
权限。 相关权限参考文档。
配置好 config 文件 和 manifest
必须指定好正确的 release-please,不同的 release-type 会决定工具查找版本文件的逻辑。
手动配置 manifest 而不使用 cli 的 bootstrap 命令。在 cli 里指定 release-type 会直接按照单 repo 生成。