---
url: /zh/build/internal-steps/git/pr-commit-message-preset.md
---
`git:pr-commit-message-preset`

\==预先设置 PR 的提交信息。==

当用户在 PR 界面中选择 Merge 或者 Squash 合并时，会自动将该 message 填入提交消息内。

* [适用事件](#git-pr-commit-message-preset-events)
* [参数](#git-pr-commit-message-preset-parameters)
* [输出结果](#git-pr-commit-message-preset-output)
* [配置样例](#git-pr-commit-message-preset-configuration-examples)

## 适用事件 {#git-pr-commit-message-preset-events}

* `pull_request`
* `pull_request.target`
* `pull_request.update`
* `pull_request.mergeable`
* `pull_request.approved`
* `pull_request.changes_requested`

## 参数 {#git-pr-commit-message-preset-parameters}

* [message](#git-pr-commit-message-preset-parameters-message)

### message {#git-pr-commit-message-preset-parameters-message}

* type: `String`
* required: `true`

预先设置的 PR 的提交信息。

## 输出结果 {#git-pr-commit-message-preset-output}

无

## 配置样例 {#git-pr-commit-message-preset-configuration-examples}

```yaml title=".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.
```