From 38334fc362a8846b960269e724437717189f9897 Mon Sep 17 00:00:00 2001
From: Rhys Arkins <rhys@arkins.net>
Date: Wed, 4 Jul 2018 09:30:29 +0200
Subject: [PATCH] feat: packageRules updateTypes
Adds an `updateTypes` field to `packageRules` that lets you specify rules based on update types such as major, minor, patch, pin, etc.
---
lib/config/definitions.js | 12 ++++++++++++
lib/config/validation.js | 1 +
lib/util/package-rules.js | 8 ++++++++
.../__snapshots__/validation.spec.js.snap | 2 +-
test/util/package-rules.spec.js | 17 +++++++++++++++++
website/docs/configuration-options.md | 11 +++++++++++
6 files changed, 50 insertions(+), 1 deletion(-)
diff --git a/lib/config/definitions.js b/lib/config/definitions.js
index 2ee0f9457c..a133080633 100644
--- a/lib/config/definitions.js
+++ b/lib/config/definitions.js
@@ -408,6 +408,18 @@ const options = [
cli: false,
env: false,
},
+ {
+ name: 'updateTypes',
+ description:
+ 'Update types to match against (major, minor, pin, etc). Valid only within `packageRules` object.',
+ type: 'list',
+ allowString: true,
+ stage: 'package',
+ parent: 'packageRules',
+ mergeable: true,
+ cli: false,
+ env: false,
+ },
// Version behaviour
{
name: 'allowedVersions',
diff --git a/lib/config/validation.js b/lib/config/validation.js
index 6b2099514f..c01b2468d3 100644
--- a/lib/config/validation.js
+++ b/lib/config/validation.js
@@ -130,6 +130,7 @@ async function validateConfig(config, isPreset, parentPath) {
'packagePatterns',
'excludePackageNames',
'excludePackagePatterns',
+ 'updateTypes',
];
if (key === 'packageRules') {
for (const packageRule of val) {
diff --git a/lib/util/package-rules.js b/lib/util/package-rules.js
index ec95b5edd3..0a620af8c7 100644
--- a/lib/util/package-rules.js
+++ b/lib/util/package-rules.js
@@ -16,6 +16,7 @@ function applyPackageRules(inputConfig) {
depName,
currentValue,
fromVersion,
+ type,
} = config;
const packageRules = config.packageRules || [];
logger.trace(
@@ -31,6 +32,7 @@ function applyPackageRules(inputConfig) {
excludePackageNames,
excludePackagePatterns,
matchCurrentVersion,
+ updateTypes,
} = packageRule;
// Setting empty arrays simplifies our logic later
paths = paths || [];
@@ -40,6 +42,7 @@ function applyPackageRules(inputConfig) {
excludePackageNames = excludePackageNames || [];
excludePackagePatterns = excludePackagePatterns || [];
matchCurrentVersion = matchCurrentVersion || null;
+ updateTypes = updateTypes || [];
let positiveMatch = false;
let negativeMatch = false;
// Massage a positive patterns patch if an exclude one is present
@@ -62,6 +65,11 @@ function applyPackageRules(inputConfig) {
positiveMatch = positiveMatch || isMatch;
negativeMatch = negativeMatch || !isMatch;
}
+ if (updateTypes.length) {
+ const isMatch = updateTypes.includes(type);
+ positiveMatch = positiveMatch || isMatch;
+ negativeMatch = negativeMatch || !isMatch;
+ }
if (packageNames.length || packagePatterns.length) {
let isMatch = packageNames.includes(depName);
// name match is "or" so we check patterns if we didn't match names
diff --git a/test/config/__snapshots__/validation.spec.js.snap b/test/config/__snapshots__/validation.spec.js.snap
index 861b627fc0..672cfcb562 100644
--- a/test/config/__snapshots__/validation.spec.js.snap
+++ b/test/config/__snapshots__/validation.spec.js.snap
@@ -44,7 +44,7 @@ Array [
},
Object {
"depName": "Configuration Error",
- "message": "packageRules: Each packageRule must contain at least one selector (paths, depTypeList, packageNames, packagePatterns, excludePackageNames, excludePackagePatterns). If you wish for configuration to apply to all packages, it is not necessary to place it inside a packageRule at all.",
+ "message": "packageRules: Each packageRule must contain at least one selector (paths, depTypeList, packageNames, packagePatterns, excludePackageNames, excludePackagePatterns, updateTypes). If you wish for configuration to apply to all packages, it is not necessary to place it inside a packageRule at all.",
},
Object {
"depName": "Configuration Error",
diff --git a/test/util/package-rules.spec.js b/test/util/package-rules.spec.js
index efed3e527c..98e90164f2 100644
--- a/test/util/package-rules.spec.js
+++ b/test/util/package-rules.spec.js
@@ -119,6 +119,23 @@ describe('applyPackageRules()', () => {
};
const res = applyPackageRules({ ...config, ...dep });
expect(res.x).toBe(1);
+ });
+ it('filters updateType', () => {
+ const config = {
+ packageRules: [
+ {
+ updateTypes: ['minor', 'patch'],
+ x: 1,
+ },
+ ],
+ };
+ const dep = {
+ depType: 'dependencies',
+ depName: 'a',
+ type: 'patch'
+ };
+ const res = applyPackageRules({ ...config, ...dep });
+ expect(res.x).toBe(1);
});
it('filters naked depType', () => {
const config = {
diff --git a/website/docs/configuration-options.md b/website/docs/configuration-options.md
index 3f86b0d4d6..2b2dc47fe1 100644
--- a/website/docs/configuration-options.md
+++ b/website/docs/configuration-options.md
@@ -434,6 +434,17 @@ Use this field if you want to have one or more package names patterns in your pa
The above will set `rangeStrategy` to `replace` for any package starting with `angular`.
+### updateTypes
+
+USe this field to match rules against types of updates. For example to apply a special label for Major updates:
+
+```
+ "packageRules: [{
+ "updateTypes": ["major"],
+ "labels": ["UPDATE-MAJOR"]
+ }]
+```
+
## patch
Add to this object if you wish to define rules that apply only to patch updates. See also `major` and `minor` configuration options.
--
GitLab