feat: prHeader and prFooter (#6511)

docs/usage/configuration-options.md

@@ -1115,6 +1115,10 @@ This setting tells Renovate when you would like it to raise PRs:
 
 Renovate defaults to `immediate` but some like to change to `not-pending`. If you configure to immediate, it means you will usually get GitHub notifications that a new PR is available but if you view it immediately then it will still have "pending" tests so you can't take any action. With `not-pending`, it means that when you receive the PR notification, you can see if it passed or failed and take action immediately. Therefore you can customise this setting if you wish to be notified a little later in order to reduce "noise".
 
+## prFooter
+
+## prHeader
+
 ## prHourlyLimit
 
 This setting - if enabled - helps slow down Renovate, particularly during the onboarding phase. What may happen without this setting is:

docs/usage/self-hosted-configuration.md

@@ -124,8 +124,6 @@ Set this to true if you wish for Renovate to persist repo data between runs. The
 
 Parameter to reduce CI load. CI jobs are usually triggered by these events: pull-request creation, pull-request update, automerge events. Set as an integer. Default is no limit.
 
-## prFooter
-
 ## printConfig
 
 This option is useful for troubleshooting, particularly if using presets. e.g. run `renovate foo/bar --print-config > config.log` and the fully-resolved config will be included in the log file.

lib/config/definitions.ts

@@ -1269,12 +1269,17 @@ const options: RenovateOptions[] = [
     default: null,
     cli: false,
   },
+  {
+    name: 'prHeader',
+    description: 'Any text added here will be placed first in the PR body.',
+    type: 'string',
+  },
   {
     name: 'prFooter',
-    description: 'Pull Request footer template',
+    description:
+      'Any text added here will be placed last in the PR body, with a divider separator before it.',
     type: 'string',
     default: `This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).`,
-    stage: 'global',
   },
   {
     name: 'lockFileMaintenance',

lib/config/index.spec.ts

@@ -40,7 +40,7 @@ describe('config/index', () => {
       );
       expect(parsedConfig).toContainEntries([
         ['token', 'abc'],
-        ['global', { prFooter: 'custom' }],
+        ['prFooter', 'custom'],
         ['logContext', 'abc123'],
         ['customPrFooter', true],
       ]);

lib/config/index.ts

@@ -111,12 +111,6 @@ export async function parseConfigs(
   delete config.logFileLevel;
 
   // Move global variables that we need to use later
-  const importGlobals = ['prBanner', 'prFooter'];
-  config.global = {};
-  importGlobals.forEach((key) => {
-    config.global[key] = config[key];
-    delete config[key];
-  });
   global.trustLevel =
     config.trustLevel || /* istanbul ignore next: never happen? */ 'low';
   delete config.trustLevel;

lib/config/validation.ts

@@ -42,7 +42,6 @@ export async function validateConfig(
   function isIgnored(key: string): boolean {
     const ignoredNodes = [
       '$schema',
-      'prBanner',
       'depType',
       'npmToken',
       'packageFile',

lib/workers/common.ts

@@ -43,7 +43,8 @@ export interface BranchUpgradeConfig
   packageFile?: string;
 
   reuseExistingBranch?: boolean;
-  prBanner?: string;
+  prHeader?: string;
+  prFooter?: string;
   prBodyNotes?: string[];
   prBodyTemplate?: string;
   prPriority?: number;

lib/workers/pr/body/footer.ts

@@ -3,8 +3,8 @@ import { BranchConfig } from '../../common';
 
 // istanbul ignore next
 export function getPrFooter(config: BranchConfig): string {
-  if (config.global && config.global.prFooter) {
-    return '\n---\n\n' + template.compile(config.global.prFooter, config);
+  if (config.prFooter) {
+    return '\n---\n\n' + template.compile(config.prFooter, config);
   }
   return '';
 }

lib/workers/pr/body/header.ts

@@ -0,0 +1,10 @@
+import * as template from '../../../util/template';
+import { BranchConfig } from '../../common';
+
+// istanbul ignore next
+export function getPrHeader(config: BranchConfig): string {
+  if (!config.prHeader) {
+    return '';
+  }
+  return template.compile(config.prHeader, config) + '\n\n';
+}

lib/workers/pr/body/index.ts

@@ -2,11 +2,11 @@ import { platform } from '../../../platform';
 import * as template from '../../../util/template';
 import { get } from '../../../versioning';
 import { BranchConfig } from '../../common';
-import { getPrBanner } from './banner';
 import { getChangelogs } from './changelogs';
 import { getPrConfigDescription } from './config-description';
 import { getControls } from './controls';
 import { getPrFooter } from './footer';
+import { getPrHeader } from './header';
 import { getPrExtraNotes, getPrNotes } from './notes';
 import { getPrUpdatesTable } from './updates-table';
 
@@ -67,7 +67,7 @@ function massageUpdateMetadata(config: BranchConfig): void {
 export async function getPrBody(config: BranchConfig): Promise<string> {
   massageUpdateMetadata(config);
   const content = {
-    banner: getPrBanner(config),
+    header: getPrHeader(config),
     table: getPrUpdatesTable(config),
     notes: getPrNotes(config) + getPrExtraNotes(config),
     changelogs: getChangelogs(config),
@@ -76,7 +76,7 @@ export async function getPrBody(config: BranchConfig): Promise<string> {
     footer: getPrFooter(config),
   };
   const defaultPrBodyTemplate =
-    '{{{banner}}}{{{table}}}{{{notes}}}{{{changelogs}}}{{{configDescription}}}{{{controls}}}{{{footer}}}';
+    '{{{header}}}{{{table}}}{{{notes}}}{{{changelogs}}}{{{configDescription}}}{{{controls}}}{{{footer}}}';
   const prBodyTemplate = config.prBodyTemplate || defaultPrBodyTemplate;
   let prBody = template.compile(prBodyTemplate, content, false);
   prBody = prBody.trim();

lib/workers/repository/init/index.ts

@@ -18,7 +18,6 @@ export async function initRepo(input: RenovateConfig): Promise<RenovateConfig> {
     warnings: [],
     branchList: [],
   };
-  config.global = config.global || {};
   config = await initApis(config);
   config.semanticCommits = await detectSemanticCommits(config);
   config.baseBranchSha = await platform.setBaseBranch(config.baseBranch);

lib/workers/repository/onboarding/pr/index.ts

@@ -88,13 +88,12 @@ If you need any further assistance then you can also [request help here](${confi
   prBody = prBody.replace('{{BASEBRANCH}}\n', getBaseBranchDesc(config));
   prBody = prBody.replace('{{PRLIST}}\n', getPrList(config, branches));
   // istanbul ignore if
-  if (config.global) {
-    if (config.global.prBanner) {
-      prBody = config.global.prBanner + '\n\n' + prBody;
-    }
-    if (config.global.prFooter) {
-      prBody = prBody + '\n---\n\n' + config.global.prFooter + '\n';
-    }
+  if (config.prHeader) {
+    prBody = (config.prHeader || '') + '\n\n' + prBody;
+  }
+  // istanbul ignore if
+  if (config.prFooter) {
+    prBody = prBody + '\n---\n\n' + config.prFooter + '\n';
   }
   logger.trace('prBody:\n' + prBody);