renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-10 05:56:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

docs(commitMessage): add example/clarification

Browse source
This commit is contained in:
Max Große 2024-12-12 23:00:26 +01:00 committed by GitHub
parent 955229edfe
commit 4e9666982d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/usage/configuration-templates.md
View file

@ -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. `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. 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 ## PR Title
Because commit messages match with the PR title, the PR title template defaults to `null` and inherits/copies the value from `commitMessage`. Because commit messages match with the PR title, the PR title template defaults to `null` and inherits/copies the value from `commitMessage`.