feat(packageRules): set skipReason=package-rules (#28952)

renovatebot · May 9, 2024 · bf22e13 · bf22e13
1 parent 2056e2d
commit bf22e13
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 1 deletion.
diff --git a/lib/config/types.ts b/lib/config/types.ts
@@ -3,7 +3,7 @@ import type { PlatformId } from '../constants';
 import type { LogLevelRemap } from '../logger/types';
 import type { CustomManager } from '../modules/manager/custom/types';
 import type { RepoSortMethod, SortMethod } from '../modules/platform/types';
-import type { HostRule } from '../types';
+import type { HostRule, SkipReason } from '../types';
 import type { GitNoVerifyOption } from '../util/git/types';
 import type { MergeConfidence } from '../util/merge-confidence/types';
 
@@ -544,6 +544,8 @@ export interface PackageRuleInputConfig extends Record<string, unknown> {
   releaseTimestamp?: string | null;
   repository?: string;
   currentVersionTimestamp?: string;
+  enabled?: boolean;
+  skipReason?: SkipReason;
 }
 
 export interface ConfigMigration {

diff --git a/lib/types/skip-reason.ts b/lib/types/skip-reason.ts
@@ -26,6 +26,7 @@ export type SkipReason =
   | 'no-source'
   | 'non-hex-dep-types'
   | 'not-a-version'
+  | 'package-rules'
   | 'path-dependency'
   | 'placeholder-url'
   | 'unknown-engines'

diff --git a/lib/util/package-rules/index.spec.ts b/lib/util/package-rules/index.spec.ts
@@ -210,6 +210,34 @@ describe('util/package-rules/index', () => {
     expect(res2.automerge).toBeFalse();
   });
 
+  it('sets skipReason=package-rules if enabled=false', () => {
+    const dep: any = {
+      depName: 'foo',
+      packageRules: [
+        {
+          enabled: false,
+        },
+      ],
+    };
+    const res = applyPackageRules(dep);
+    expect(res.enabled).toBeFalse();
+    expect(res.skipReason).toBe('package-rules');
+  });
+
+  it('skips skipReason=package-rules if enabled=true', () => {
+    const dep: any = {
+      enabled: false,
+      depName: 'foo',
+      packageRules: [
+        {
+          enabled: false,
+        },
+      ],
+    };
+    const res = applyPackageRules(dep);
+    expect(res.skipReason).toBeUndefined();
+  });
+
   it('matches anything if missing inclusive rules', () => {
     const config: TestConfig = {
       packageRules: [

diff --git a/lib/util/package-rules/index.ts b/lib/util/package-rules/index.ts
@@ -80,6 +80,9 @@ export function applyPackageRules<T extends PackageRuleInputConfig>(
           lower: true,
         });
       }
+      if (toApply.enabled === false && config.enabled !== false) {
+        config.skipReason = 'package-rules';
+      }
       config = mergeChildConfig(config, toApply);
     }
   }