From 21ed038eeda536690dd99f769cac3599fc7d994a Mon Sep 17 00:00:00 2001
From: Rhys Arkins <rhys@arkins.net>
Date: Sat, 28 Jul 2018 20:43:54 +0200
Subject: [PATCH] fix: add commitMessageSuffix to definitions
---
lib/config/definitions.js | 6 ++++++
.../repository/updates/__snapshots__/flatten.spec.js.snap | 4 ++++
website/docs/configuration-options.md | 4 ++++
3 files changed, 14 insertions(+)
diff --git a/lib/config/definitions.js b/lib/config/definitions.js
index 2fb7ff9869..5f0b8719ba 100644
--- a/lib/config/definitions.js
+++ b/lib/config/definitions.js
@@ -754,6 +754,12 @@ const options = [
'to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}',
cli: false,
},
+ {
+ name: 'commitMessageSuffix',
+ description: 'Suffix to add to end of commit messages and PR titles.',
+ type: 'string',
+ cli: false,
+ },
{
name: 'prTitle',
description:
diff --git a/test/workers/repository/updates/__snapshots__/flatten.spec.js.snap b/test/workers/repository/updates/__snapshots__/flatten.spec.js.snap
index 5d72240ee7..3ad256d0c8 100644
--- a/test/workers/repository/updates/__snapshots__/flatten.spec.js.snap
+++ b/test/workers/repository/updates/__snapshots__/flatten.spec.js.snap
@@ -16,6 +16,7 @@ Array [
"commitMessageAction": "Update",
"commitMessageExtra": "to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}",
"commitMessagePrefix": null,
+ "commitMessageSuffix": null,
"commitMessageTopic": "dependency {{depName}}",
"copyLocalLibs": false,
"depName": "@org/a",
@@ -77,6 +78,7 @@ Array [
"commitMessageAction": "Update",
"commitMessageExtra": "to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}",
"commitMessagePrefix": null,
+ "commitMessageSuffix": null,
"commitMessageTopic": "dependency {{depName}}",
"copyLocalLibs": false,
"depNameSanitized": undefined,
@@ -137,6 +139,7 @@ Array [
"commitMessageAction": "Lock file maintenance",
"commitMessageExtra": null,
"commitMessagePrefix": null,
+ "commitMessageSuffix": null,
"commitMessageTopic": null,
"copyLocalLibs": false,
"errors": Array [],
@@ -211,6 +214,7 @@ Array [
"commitMessageAction": "Update",
"commitMessageExtra": "to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}",
"commitMessagePrefix": null,
+ "commitMessageSuffix": null,
"commitMessageTopic": "{{{depName}}} Docker tag",
"copyLocalLibs": false,
"depName": "amd64/node",
diff --git a/website/docs/configuration-options.md b/website/docs/configuration-options.md
index 9c123dd853..986c61f481 100644
--- a/website/docs/configuration-options.md
+++ b/website/docs/configuration-options.md
@@ -120,6 +120,10 @@ This is used to alter `commitMessage` and `prTitle` without needing to copy/past
This is used to alter `commitMessage` and `prTitle` without needing to copy/paste the whole string. The "prefix" is usually an automatically applied semantic commit prefix, however it can also be statically configured.
+## commitMessageSuffix
+
+This is used to add a suffix to commit messages. Usually left empty except for internal use (multiple base branches, and vulnerability alerts).
+
## 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".
--
GitLab