git:pr-commit-message-preset
330 字约 1 分钟
git:pr-commit-message-preset
预先设置 PR 的提交信息。
当用户在 PR 界面中选择 Merge 或者 Squash 合并时,会自动将该 message 填入提交消息内。
使用场景:希望 PR 的合并提交信息符合规范、且不必人工填写时使用——例如在 PR 创建时 按变更内容生成规范化的提交信息,用户合并时直接采用。 写脚本无法在合并前设置这份信息,git:pr-commit-message-preset 把这一步收敛成一个内置任务。
适用事件
pull_requestpull_request.targetpull_request.updatepull_request.mergeablepull_request.approvedpull_request.changes_requested
参数
message
- type:
String - required:
true
预先设置的 PR 的提交信息。
输出结果
无
配置样例
.cnb.yml
main:
pull_request:
- stages:
- name: prepare pull request commit message
type: git:pr-commit-message-preset
options:
message: Pull request commit message set by CI.