feat(config): warn if globalOnly option found in repo config (renov…

…atebot#24561) Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
scm-manager · Jan 24, 2024 · 3736000 · 3736000
1 parent e99cef6
commit 3736000
Show file tree

Hide file tree

Showing 7 changed files with 188 additions and 54 deletions.
diff --git a/lib/config-validator.ts b/lib/config-validator.ts
@@ -17,6 +17,7 @@ import {
 let returnVal = 0;
 
 async function validate(
+  isGlobalConfig: boolean,
   desc: string,
   config: RenovateConfig,
   strict: boolean,
@@ -36,7 +37,7 @@ async function validate(
     }
   }
   const massagedConfig = massageConfig(migratedConfig);
-  const res = await validateConfig(massagedConfig, isPreset);
+  const res = await validateConfig(isGlobalConfig, massagedConfig, isPreset);
   if (res.errors.length) {
     logger.error(
       { file: desc, errors: res.errors },
@@ -75,7 +76,7 @@ type PackageJson = {
         const parsedContent = await getParsedContent(file);
         try {
           logger.info(`Validating ${file}`);
-          await validate(file, parsedContent, strict);
+          await validate(true, file, parsedContent, strict);
         } catch (err) {
           logger.warn({ file, err }, 'File is not valid Renovate config');
           returnVal = 1;
@@ -96,7 +97,7 @@ type PackageJson = {
         const parsedContent = await getParsedContent(file);
         try {
           logger.info(`Validating ${file}`);
-          await validate(file, parsedContent, strict);
+          await validate(false, file, parsedContent, strict);
         } catch (err) {
           logger.warn({ file, err }, 'File is not valid Renovate config');
           returnVal = 1;
@@ -112,12 +113,18 @@ type PackageJson = {
       ) as PackageJson;
       if (pkgJson.renovate) {
         logger.info(`Validating package.json > renovate`);
-        await validate('package.json > renovate', pkgJson.renovate, strict);
+        await validate(
+          false,
+          'package.json > renovate',
+          pkgJson.renovate,
+          strict,
+        );
       }
       if (pkgJson['renovate-config']) {
         logger.info(`Validating package.json > renovate-config`);
         for (const presetConfig of Object.values(pkgJson['renovate-config'])) {
           await validate(
+            false,
             'package.json > renovate-config',
             presetConfig,
             strict,
@@ -134,7 +141,7 @@ type PackageJson = {
         const file = process.env.RENOVATE_CONFIG_FILE ?? 'config.js';
         logger.info(`Validating ${file}`);
         try {
-          await validate(file, fileConfig, strict);
+          await validate(true, file, fileConfig, strict);
         } catch (err) {
           logger.error({ file, err }, 'File is not valid Renovate config');
           returnVal = 1;

diff --git a/lib/config/__snapshots__/validation.spec.ts.snap b/lib/config/__snapshots__/validation.spec.ts.snap
@@ -37,6 +37,10 @@ exports[`config/validation validateConfig(config) catches invalid templates 1`]
 
 exports[`config/validation validateConfig(config) errors for all types 1`] = `
 [
+  {
+    "message": "Configuration option \`azureWorkItemId\` should be an integer. Found: false (boolean)",
+    "topic": "Configuration Error",
+  },
   {
     "message": "Configuration option \`enabled\` should be boolean. Found: 1 (number)",
     "topic": "Configuration Error",
@@ -57,10 +61,6 @@ exports[`config/validation validateConfig(config) errors for all types 1`] = `
     "message": "Configuration option \`packageRules[3].matchPackagePatterns\` should be a list (Array)",
     "topic": "Configuration Error",
   },
-  {
-    "message": "Configuration option \`prCommitsPerRunLimit\` should be an integer. Found: false (boolean)",
-    "topic": "Configuration Error",
-  },
   {
     "message": "Configuration option \`semanticCommitType\` should be a string",
     "topic": "Configuration Error",

diff --git a/lib/config/migrate-validate.ts b/lib/config/migrate-validate.ts
@@ -32,7 +32,7 @@ export async function migrateAndValidate(
     }: {
       warnings: ValidationMessage[];
       errors: ValidationMessage[];
-    } = await configValidation.validateConfig(massagedConfig);
+    } = await configValidation.validateConfig(false, massagedConfig);
     // istanbul ignore if
     if (is.nonEmptyArray(warnings)) {
       logger.warn({ warnings }, 'Found renovate config warnings');

diff --git a/lib/config/presets/internal/index.spec.ts b/lib/config/presets/internal/index.spec.ts
@@ -30,7 +30,7 @@ describe('config/presets/internal/index', () => {
             const config = await resolveConfigPresets(
               massageConfig(presetConfig),
             );
-            const res = await validateConfig(config, true);
+            const res = await validateConfig(false, config, true);
             expect(res.errors).toHaveLength(0);
             expect(res.warnings).toHaveLength(0);
           } catch (err) {