From db73d3984b91145e2979da40acefe21d91c24c98 Mon Sep 17 00:00:00 2001
From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Date: Wed, 22 Mar 2023 07:37:40 +0100
Subject: [PATCH] docs(config options): `improveprBodyTemplate` explanation
(#20945)
---
docs/usage/configuration-options.md | 13 ++++++++++---
lib/config/options/index.ts | 2 +-
2 files changed, 11 insertions(+), 4 deletions(-)
diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md
index 44d6474613..f10d61d4ee 100644
--- a/docs/usage/configuration-options.md
+++ b/docs/usage/configuration-options.md
@@ -2470,9 +2470,16 @@ 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.
+The available sections are:
+
+- `header`
+- `table`
+- `warnings`
+- `notes`
+- `changelogs`
+- `configDescription`
+- `controls`
+- `footer`
## prConcurrentLimit
diff --git a/lib/config/options/index.ts b/lib/config/options/index.ts
index e140838639..f178e974de 100644
--- a/lib/config/options/index.ts
+++ b/lib/config/options/index.ts
@@ -1832,7 +1832,7 @@ const options: RenovateOptions[] = [
{
name: 'prBodyTemplate',
description:
- 'Pull Request body template. Controls which sections are rendered in the body.',
+ 'Pull Request body template. Controls which sections are rendered in the body of the pull request.',
type: 'string',
default:
'{{{header}}}{{{table}}}{{{warnings}}}{{{notes}}}{{{changelogs}}}{{{configDescription}}}{{{controls}}}{{{footer}}}',
--
GitLab