feat: show warning in pr body

lib/config/options/index.ts

@@ -1691,7 +1691,7 @@ const options: RenovateOptions[] = [
       'Pull Request body template. Controls which sections are rendered in the body.',
     type: 'string',
     default:
-      '{{{header}}}{{{table}}}{{{notes}}}{{{changelogs}}}{{{configDescription}}}{{{controls}}}{{{footer}}}',
+      '{{{header}}}{{{table}}}{{{warnings}}}{{{notes}}}{{{changelogs}}}{{{configDescription}}}{{{controls}}}{{{footer}}}',
     cli: false,
   },
   {

lib/workers/repository/errors-warnings.spec.ts

@@ -49,7 +49,8 @@ describe('workers/repository/errors-warnings', () => {
       jest.resetAllMocks();
     });
 
-    it('returns pr warning text', () => {
+    it('returns 2 pr warnings text dependencyDashboard true', () => {
+      const dependencyDashboard = true;
       const packageFiles: Record<string, PackageFile[]> = {
         npm: [
           {
@@ -82,19 +83,61 @@ describe('workers/repository/errors-warnings', () => {
         ],
       };
 
-      const res = getDepWarningsPR(packageFiles);
+      const res = getDepWarningsPR(packageFiles, dependencyDashboard);
       expect(res).toMatchInlineSnapshot(`
         "
         ---
 
         ### ⚠ Dependency Lookup Warnings ⚠
 
-        Please correct - or verify that you can safely ignore - these lookup failures before you merge this PR.
+        Warnings were logged while processing this repo. Please check the Dependency Dashboard for further information
 
-        -   \`Warning 1\`
-        -   \`Warning 2\`
+        "
+      `);
+    });
 
-        Files affected: \`package.json\`, \`backend/package.json\`, \`Dockerfile\`
+    it('returns 2 pr warnings text dependencyDashboard false', () => {
+      const dependencyDashboard = false;
+      const packageFiles: Record<string, PackageFile[]> = {
+        npm: [
+          {
+            packageFile: 'package.json',
+            deps: [
+              {
+                warnings: [{ message: 'Warning 1', topic: '' }],
+              },
+              {},
+            ],
+          },
+          {
+            packageFile: 'backend/package.json',
+            deps: [
+              {
+                warnings: [{ message: 'Warning 1', topic: '' }],
+              },
+            ],
+          },
+        ],
+        dockerfile: [
+          {
+            packageFile: 'Dockerfile',
+            deps: [
+              {
+                warnings: [{ message: 'Warning 2', topic: '' }],
+              },
+            ],
+          },
+        ],
+      };
+
+      const res = getDepWarningsPR(packageFiles, dependencyDashboard);
+      expect(res).toMatchInlineSnapshot(`
+        "
+        ---
+
+        ### ⚠ Dependency Lookup Warnings ⚠
+
+        Warnings were logged while processing this repo. Please check logs for further information
 
         "
       `);

lib/workers/repository/errors-warnings.ts

@@ -58,7 +58,8 @@ function getDepWarnings(
 }
 
 export function getDepWarningsPR(
-  packageFiles: Record<string, PackageFile[]>
+  packageFiles: Record<string, PackageFile[]>,
+  dependencyDashboard?: boolean
 ): string {
   const { warnings, warningFiles } = getDepWarnings(packageFiles);
   let warningText = '';
@@ -69,14 +70,11 @@ export function getDepWarningsPR(
   warningText = emojify(
     `\n---\n\n### :warning: Dependency Lookup Warnings :warning:\n\n`
   );
-  warningText += `Please correct - or verify that you can safely ignore - these lookup failures before you merge this PR.\n\n`;
-  for (const w of warnings) {
-    warningText += `-   \`${w}\`\n`;
+  if (dependencyDashboard) {
+    warningText += `Warnings were logged while processing this repo. Please check the Dependency Dashboard for further information\n\n`;
+  } else {
+    warningText += `Warnings were logged while processing this repo. Please check logs for further information\n\n`;
   }
-  warningText +=
-    '\nFiles affected: ' +
-    warningFiles.map((f) => '`' + f + '`').join(', ') +
-    '\n\n';
   return warningText;
 }
 

lib/workers/repository/update/pr/body/index.spec.ts

@@ -1,4 +1,5 @@
 import { mocked, platform } from '../../../../../../test/util';
+import type { PackageFile } from '../../../../../modules/manager/types';
 import { prDebugDataRe } from '../../../../../modules/platform/pr-body';
 import * as _template from '../../../../../util/template';
 import * as _changelogs from './changelogs';
@@ -199,5 +200,54 @@ describe('workers/repository/update/pr/body/index', () => {
       const match = prDebugDataRe.exec(res);
       expect(match?.groups?.payload).toBeString();
     });
+
+    it('pr body warning', async () => {
+      const massagedMarkDown =
+        '---\n\n### ⚠ Dependency Lookup Warnings ⚠\n\n' +
+        'Warnings were logged while processing this repo. ' +
+        'Please check the Dependency Dashboard for further information\n\n---';
+
+      const compiledContent =
+        '---\n\n\n\n### ⚠ Dependency Lookup Warnings ⚠' +
+        '\n\n\n\nWarnings were logged while processing this repo. ' +
+        'Please check the Dependency Dashboard for further information\n\n\n\n---';
+
+      platform.massageMarkdown.mockImplementation((x) => massagedMarkDown);
+      template.compile.mockImplementation((x) => compiledContent);
+      const packageFiles: Record<string, PackageFile[]> = {
+        npm: [
+          {
+            packageFile: 'package.json',
+            deps: [
+              {
+                warnings: [{ message: 'Warning 1', topic: '' }],
+              },
+              {},
+            ],
+          },
+        ],
+      };
+
+      const res = await getPrBody(
+        {
+          manager: 'some-manager',
+          branchName: 'some-branch',
+          upgrades: [],
+          packageFiles: packageFiles,
+          prBodyTemplate: '{{{warnings}}}',
+        },
+        {
+          debugData: {
+            updatedInVer: '1.2.3',
+            createdInVer: '1.2.3',
+          },
+        }
+      );
+      const expected =
+        '---\n\n### ⚠ Dependency Lookup Warnings ⚠' +
+        '\n\nWarnings were logged while processing this repo. ' +
+        'Please check the Dependency Dashboard for further information\n\n---';
+      expect(res).toBe(expected);
+    });
   });
 });

lib/workers/repository/update/pr/body/index.ts

@@ -4,6 +4,7 @@ import { toBase64 } from '../../../../../util/string';
 import * as template from '../../../../../util/template';
 import { joinUrlParts } from '../../../../../util/url';
 import type { BranchConfig } from '../../../../types';
+import { getDepWarningsPR, getWarnings } from '../../../errors-warnings';
 import { getChangelogs } from './changelogs';
 import { getPrConfigDescription } from './config-description';
 import { getControls } from './controls';
@@ -69,9 +70,18 @@ export async function getPrBody(
   prBodyConfig: PrBodyConfig
 ): Promise<string> {
   massageUpdateMetadata(branchConfig);
+  let warn = '';
+  warn += getWarnings(branchConfig);
+  if (branchConfig.packageFiles) {
+    warn += getDepWarningsPR(
+      branchConfig.packageFiles,
+      branchConfig.dependencyDashboard
+    );
+  }
   const content = {
     header: getPrHeader(branchConfig),
     table: getPrUpdatesTable(branchConfig),
+    warnings: warn,
     notes: getPrNotes(branchConfig) + getPrExtraNotes(branchConfig),
     changelogs: getChangelogs(branchConfig),
     configDescription: await getPrConfigDescription(branchConfig),