Skip to content

Commit

Permalink
docs(commitMessage): add example/clarification
Browse files Browse the repository at this point in the history
  • Loading branch information
maxRN authored Dec 12, 2024
1 parent 955229e commit 4e96669
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/usage/configuration-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,25 @@ It can be empty in some cases, like if the action/topic doesn't change a package
`commitBody` is used if you wish to add multi-line commit messages, such as for the `Signed-off-by` fields, or adding `[skip-ci]`, etc.
It is appended to the generated `commitMessage`, separated by a newline.

If you configuration uses [groups](https://docs.renovatebot.com/configuration-options/#group) you need to put the above configuration options under the `group` property and might also need to
enable [`prTitleStrict`](https://docs.renovatebot.com/configuration-options/#prtitlestrict).
Example:
```json
{
"matchDatasources": ["npm"],
"matchPackageNames": ["*"],
"matchUpdateTypes": ["major"],
"groupName": "frontend_major",
"prTitleStrict": true,
"group": {
"commitMessagePrefix": "[RENOVATE]",
"commitMessageTopic": "FE major dependencies",
"commitMessageExtra": "",
"commitMessageSuffix": ""
}
}
```

## PR Title

Because commit messages match with the PR title, the PR title template defaults to `null` and inherits/copies the value from `commitMessage`.
Expand Down

0 comments on commit 4e96669

Please sign in to comment.