From acf57144f871322d1c54120159bb8f01d88e7cd8 Mon Sep 17 00:00:00 2001 From: Rhys Arkins <rhys@arkins.net> Date: Tue, 16 Feb 2021 09:43:38 +0100 Subject: [PATCH] refactor: remove currentVersion (#8708) --- lib/config/__snapshots__/migration.spec.ts.snap | 17 ++++++++++++++++- lib/config/migration.spec.ts | 4 ++-- lib/config/migration.ts | 2 +- lib/datasource/terraform-module/index.ts | 6 +++--- lib/datasource/terraform-provider/index.ts | 6 +++--- lib/manager/bazel/update.ts | 8 ++++---- lib/manager/common.ts | 1 - lib/manager/gomod/update.spec.ts | 2 -- lib/util/template/index.ts | 3 +-- lib/workers/common.ts | 1 - lib/workers/repository/updates/flatten.ts | 2 -- lib/workers/repository/updates/generate.ts | 8 ++------ 12 files changed, 32 insertions(+), 28 deletions(-) diff --git a/lib/config/__snapshots__/migration.spec.ts.snap b/lib/config/__snapshots__/migration.spec.ts.snap index 17374dfdea..fe40723c69 100644 --- a/lib/config/__snapshots__/migration.spec.ts.snap +++ b/lib/config/__snapshots__/migration.spec.ts.snap @@ -88,7 +88,6 @@ Object { "branchName": "{{{branchPrefix}}}{{{additionalBranchPrefix}}}{{{branchTopic}}}{{{packageFileDir}}}", "branchPrefix": "renovate/", "commitMessage": "{{#if semanticCommitType}}{{semanticCommitType}}{{#if semanticCommitScope}}({{semanticCommitScope}}){{/if}}: {{/if}}some commit message", - "commitMessageExtra": "{{currentValue}} something", "constraints": Object { "python": "3.7", }, @@ -323,6 +322,22 @@ Object { } `; +exports[`config/migration migrateConfig(config, parentConfig) migrates packageRules objects 1`] = ` +Object { + "packageRules": Array [ + Object { + "commitMessage": "fix(package): update peerDependency to accept typescript ^{{newValue}} {{newValue}}", + "matchPackageNames": Array [ + "typescript", + ], + "matchUpdateTypes": Array [ + "major", + ], + }, + ], +} +`; + exports[`config/migration migrateConfig(config, parentConfig) migrates packages 1`] = ` Object { "packageRules": Array [ diff --git a/lib/config/migration.spec.ts b/lib/config/migration.spec.ts index 4c717514a1..9298ffcb8c 100644 --- a/lib/config/migration.spec.ts +++ b/lib/config/migration.spec.ts @@ -76,7 +76,6 @@ describe('config/migration', () => { commitMessage: '{{semanticPrefix}}some commit message', prTitle: '{{semanticPrefix}}some pr title', semanticPrefix: 'fix(deps): ', - commitMessageExtra: '{{currentVersion}} something', pathRules: [ { paths: ['examples/**'], @@ -314,7 +313,7 @@ describe('config/migration', () => { packageNames: ['typescript'], updateTypes: ['major'], commitMessage: - 'fix(package): update peerDependency to accept typescript ^{{newVersion}}', + 'fix(package): update peerDependency to accept typescript ^{{newVersion}} {{newVersion}}', }, } as any; const { isMigrated, migratedConfig } = configMigration.migrateConfig( @@ -322,6 +321,7 @@ describe('config/migration', () => { defaultConfig ); expect(isMigrated).toBe(true); + expect(migratedConfig).toMatchSnapshot(); expect(migratedConfig.packageRules).toHaveLength(1); }); it('migrates node to travis', () => { diff --git a/lib/config/migration.ts b/lib/config/migration.ts index 208e359725..0f18e7044a 100644 --- a/lib/config/migration.ts +++ b/lib/config/migration.ts @@ -504,7 +504,7 @@ export function migrateConfig( migratedConfig.binarySource = 'global'; } const migratedTemplates = { - currentVersion: 'currentValue', + currentVersion: 'toVersion', newVersion: 'newValue', newValueMajor: 'newMajor', newValueMinor: 'newMinor', diff --git a/lib/datasource/terraform-module/index.ts b/lib/datasource/terraform-module/index.ts index df7e5c5d3c..1e9b69b3da 100644 --- a/lib/datasource/terraform-module/index.ts +++ b/lib/datasource/terraform-module/index.ts @@ -137,11 +137,11 @@ export async function getReleases({ dep.homepage = `https://registry.terraform.io/modules/${repository}`; } // set published date for latest release - const currentVersion = dep.releases.find( + const latestVersion = dep.releases.find( (release) => res.version === release.version ); - if (currentVersion) { - currentVersion.releaseTimestamp = res.published_at; + if (latestVersion) { + latestVersion.releaseTimestamp = res.published_at; } logger.trace({ dep }, 'dep'); const cacheMinutes = 30; diff --git a/lib/datasource/terraform-provider/index.ts b/lib/datasource/terraform-provider/index.ts index c41de0dfef..6a7274a637 100644 --- a/lib/datasource/terraform-provider/index.ts +++ b/lib/datasource/terraform-provider/index.ts @@ -59,12 +59,12 @@ async function queryRegistry( version, })); // set published date for latest release - const currentVersion = dep.releases.find( + const latestVersion = dep.releases.find( (release) => res.version === release.version ); // istanbul ignore else - if (currentVersion) { - currentVersion.releaseTimestamp = res.published_at; + if (latestVersion) { + latestVersion.releaseTimestamp = res.published_at; } dep.homepage = `${registryURL}/providers/${repository}`; logger.trace({ dep }, 'dep'); diff --git a/lib/manager/bazel/update.ts b/lib/manager/bazel/update.ts index 849689e794..1d2dbcd5b2 100644 --- a/lib/manager/bazel/update.ts +++ b/lib/manager/bazel/update.ts @@ -12,12 +12,12 @@ function updateWithNewVersion( currentValue: string, newValue: string ): string { - const currentVersion = currentValue.replace(/^v/, ''); - const newVersion = newValue.replace(/^v/, ''); + const replaceFrom = currentValue.replace(/^v/, ''); + const replaceTo = newValue.replace(/^v/, ''); let newContent = content; do { - newContent = newContent.replace(currentVersion, newVersion); - } while (newContent.includes(currentVersion)); + newContent = newContent.replace(replaceFrom, replaceTo); + } while (newContent.includes(replaceFrom)); return newContent; } diff --git a/lib/manager/common.ts b/lib/manager/common.ts index eee1db6479..34d0115ed4 100644 --- a/lib/manager/common.ts +++ b/lib/manager/common.ts @@ -187,7 +187,6 @@ export interface Upgrade<T = Record<string, any>> NpmLockFiles { isLockfileUpdate?: boolean; currentRawValue?: any; - currentVersion?: string; depGroup?: string; dockerRepository?: string; localDir?: string; diff --git a/lib/manager/gomod/update.spec.ts b/lib/manager/gomod/update.spec.ts index 66e2e0d225..5ceea4ad50 100644 --- a/lib/manager/gomod/update.spec.ts +++ b/lib/manager/gomod/update.spec.ts @@ -153,7 +153,6 @@ describe('manager/gomod/update', () => { const upgrade = { depName: 'github.com/spf13/jwalterweatherman', managerData: { lineNumber: 43, multiLine: true }, - currentVersion: 'v0.0.0', updateType: 'digest' as UpdateType, currentDigest: '14d3d4c51834', newDigest: '123456123456abcdef', @@ -168,7 +167,6 @@ describe('manager/gomod/update', () => { const upgrade = { depName: 'github.com/spf13/jwalterweatherman', managerData: { lineNumber: 43, multiLine: true }, - currentVersion: 'v0.0.0', updateType: 'digest' as UpdateType, currentDigest: 'abcdefabcdef', newDigest: '14d3d4c51834000000', diff --git a/lib/util/template/index.ts b/lib/util/template/index.ts index 7ff0914c5a..86ca71253f 100644 --- a/lib/util/template/index.ts +++ b/lib/util/template/index.ts @@ -40,7 +40,6 @@ export const allowedFields = { baseBranch: 'The baseBranch for this branch/PR', body: 'The body of the release notes', currentValue: 'The extracted current value of the dependency being updated', - currentVersion: 'The current version that is being updated', datasource: 'The datasource used to look up the upgrade', depName: 'The name of the dependency being updated', depNameLinked: @@ -52,7 +51,7 @@ export const allowedFields = { displayFrom: 'The current value, formatted for display', displayTo: 'The to value, formatted for display', fromVersion: - 'The version that would be currently installed. For example, if currentValue is ^3.0.0 then currentVersion might be 3.1.0.', + 'The version that would be currently installed. For example, if currentValue is ^3.0.0 then fromVersion might be 3.1.0.', hasReleaseNotes: 'true if the upgrade has release notes', isLockfileUpdate: 'true if the branch is a lock file update', isMajor: 'true if the upgrade is major', diff --git a/lib/workers/common.ts b/lib/workers/common.ts index 4c0a31080d..0467627925 100644 --- a/lib/workers/common.ts +++ b/lib/workers/common.ts @@ -31,7 +31,6 @@ export interface BranchUpgradeConfig currentDigest?: string; currentDigestShort?: string; currentValue?: string; - currentVersion?: string; endpoint?: string; excludeCommitPaths?: string[]; githubName?: string; diff --git a/lib/workers/repository/updates/flatten.ts b/lib/workers/repository/updates/flatten.ts index e5dd2d39a3..d44f7801b3 100644 --- a/lib/workers/repository/updates/flatten.ts +++ b/lib/workers/repository/updates/flatten.ts @@ -48,8 +48,6 @@ export async function flattenUpdates( for (const update of dep.updates) { let updateConfig = mergeChildConfig(depConfig, update); delete updateConfig.updates; - // Massage legacy vars just in case - updateConfig.currentVersion = updateConfig.currentValue; updateConfig.newVersion = updateConfig.newVersion || updateConfig.newValue; if (updateConfig.updateType) { diff --git a/lib/workers/repository/updates/generate.ts b/lib/workers/repository/updates/generate.ts index 04ff5ffd94..5b7da66351 100644 --- a/lib/workers/repository/updates/generate.ts +++ b/lib/workers/repository/updates/generate.ts @@ -120,8 +120,7 @@ export function generateBranchConfig( } if (!upgrade.displayFrom) { if (upgrade.currentValue === upgrade.newValue) { - upgrade.displayFrom = - upgrade.currentDigestShort || upgrade.currentVersion || ''; + upgrade.displayFrom = upgrade.currentDigestShort || ''; upgrade.displayTo = upgrade.displayTo || upgrade.newDigestShort || @@ -129,10 +128,7 @@ export function generateBranchConfig( ''; } else { upgrade.displayFrom = - upgrade.currentValue || - upgrade.currentVersion || - upgrade.currentDigestShort || - ''; + upgrade.currentValue || upgrade.currentDigestShort || ''; upgrade.displayTo = upgrade.displayTo || upgrade.newValue || -- GitLab