diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 804a2b8ba16d29fc96fb3ff4834780fcdeaa649c..3ec5ee9759a02074bd5e73be2ebd33fbc1558e0b 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 f9883c8f07943169571039051a98e67b63a7d435..3e7fd0858b9414ac6bd6b89b29afee526073d954 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 5590e6100e3f5ffcd56ea03a59b462e98d83bb59..7c844e906efacbd9b50cd1186ce3dd0985d510ad 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');