Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(commitMessage): add example/clarification #33075

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(commitMessage): add example/clarification #33075

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/usage/configuration-templates.md
View file
Open in desktop
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