From 3598b814a0e30c0e5e45cb61930ee3daa4390f3c Mon Sep 17 00:00:00 2001
From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Date: Sat, 7 Jan 2023 14:02:41 +0100
Subject: [PATCH] docs: recommend set commitMessageTopic with packageRules
(#19689)
---
docs/usage/configuration-options.md | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md
index 1b370c7d6d..23f6909cbe 100644
--- a/docs/usage/configuration-options.md
+++ b/docs/usage/configuration-options.md
@@ -408,8 +408,21 @@ Usually left empty except for internal use (multiple base branches, and vulnerab
## commitMessageTopic
-This is used to alter `commitMessage` and `prTitle` without needing to copy/paste the whole string.
-The "topic" is usually refers to the dependency being updated, e.g. `"dependency react"`.
+You can use `commitMessageTopic` to change the `commitMessage` and `prTitle` without copy/pasting the whole string.
+The "topic" usually refers to the dependency being updated, for example: `"dependency react"`.
+
+We recommend you use `matchManagers` and `commitMessageTopic` in a `packageRules` array to set the commit message topic, like this:
+
+```json
+{
+ "packageRules": [
+ {
+ "matchManagers": ["github-actions"],
+ "commitMessageTopic": "{{depName}}"
+ }
+ ]
+}
+```
## composerIgnorePlatformReqs
--
GitLab