From d78dc8f01cb210af9a34c91b881729dda1b03130 Mon Sep 17 00:00:00 2001
From: Julien Poissonnier <julien@caffeine.lu>
Date: Fri, 28 Aug 2020 09:27:31 +0200
Subject: [PATCH] feat(config): Add support for prBodyTemplate (#7122)
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
---
docs/usage/configuration-options.md | 6 ++++++
lib/config/definitions.ts | 9 +++++++++
lib/workers/pr/body/index.ts | 4 +---
3 files changed, 16 insertions(+), 3 deletions(-)
diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md
index 804a2b8ba1..3ec5ee9759 100644
--- a/docs/usage/configuration-options.md
+++ b/docs/usage/configuration-options.md
@@ -1189,6 +1189,12 @@ e.g. if you wish to add an extra Warning to major updates:
}
```
+## prBodyTemplate
+
+This setting controls which sections are rendered in the body of the pull request.
+
+The available sections are header, table, notes, changelogs, configDescription, controls, footer.
+
## prConcurrentLimit
This setting - if enabled - limits Renovate to a maximum of x concurrent PRs open at any time.
diff --git a/lib/config/definitions.ts b/lib/config/definitions.ts
index f9883c8f07..3e7fd0858b 100644
--- a/lib/config/definitions.ts
+++ b/lib/config/definitions.ts
@@ -1294,6 +1294,15 @@ const options: RenovateOptions[] = [
type: 'string',
cli: false,
},
+ {
+ name: 'prBodyTemplate',
+ description:
+ 'Pull Request body template. Controls which sections are rendered in the body.',
+ type: 'string',
+ default:
+ '{{{header}}}{{{table}}}{{{notes}}}{{{changelogs}}}{{{configDescription}}}{{{controls}}}{{{footer}}}',
+ cli: false,
+ },
{
name: 'prTitle',
description:
diff --git a/lib/workers/pr/body/index.ts b/lib/workers/pr/body/index.ts
index 5590e6100e..7c844e906e 100644
--- a/lib/workers/pr/body/index.ts
+++ b/lib/workers/pr/body/index.ts
@@ -75,9 +75,7 @@ export async function getPrBody(config: BranchConfig): Promise<string> {
controls: getControls(),
footer: getPrFooter(config),
};
- const defaultPrBodyTemplate =
- '{{{header}}}{{{table}}}{{{notes}}}{{{changelogs}}}{{{configDescription}}}{{{controls}}}{{{footer}}}';
- const prBodyTemplate = config.prBodyTemplate || defaultPrBodyTemplate;
+ const prBodyTemplate = config.prBodyTemplate;
let prBody = template.compile(prBodyTemplate, content, false);
prBody = prBody.trim();
prBody = prBody.replace(/\n\n\n+/g, '\n\n');
--
GitLab