chore: migrate and fix Renovate config

[MikeMcC399]

Situation

The Renovate Dependency Dashboard indicates:

Config Migration Needed

• Select this checkbox to let Renovate create an automated Config Migration PR.

Repository problems

These problems occurred while renovating this repository. View logs.

• WARN: Found renovate config warnings

The renovate.json configuration was last updated 6 years ago in March 2019.

Applying Config Validation by executing:

npx --yes --package renovate -- renovate-config-validator

shows the following:

$ npx --yes --package renovate -- renovate-config-validator
 INFO: Validating renovate.json
 WARN: Config migration necessary
       "oldConfig": {
         "extends": ["config:base"],
         "automerge": true,
         "commitMessage": "{{semanticPrefix}}Update {{depName}} to {{newVersion}} 🌟",
         "prTitle": "{{semanticPrefix}}{{#if isPin}}Pin{{else}}Update{{/if}} dependency {{depName}} to version {{newVersion}} 🌟",
         "major": {"automerge": false},
         "minor": {"automerge": false},
         "prConcurrentLimit": 3,
         "prHourlyLimit": 2,
         "schedule": ["after 2am and before 3am on saturday"],
         "updateNotScheduled": false,
         "timezone": "America/New_York",
         "lockFileMaintenance": {"enabled": true},
         "separatePatchReleases": true,
         "separateMultipleMajor": true,
         "masterIssue": true,
         "labels": ["type: dependencies", "renovate"],
         "packageRules": [
           {
             "packageNames": ["cypress"],
             "groupName": "cypress",
             "schedule": "before 2am"
           },
           {"packagePatterns": "^eslint", "groupName": "eslint"}
         ]
       },
       "newConfig": {
         "extends": ["config:recommended"],
         "automerge": true,
         "commitMessage": "{{#if semanticCommitType}}{{semanticCommitType}}{{#if semanticCommitScope}}({{semanticCommitScope}}){{/if}}: {{/if}}Update {{depName}} to {{newVersion}} 🌟",
         "prTitle": "{{#if semanticCommitType}}{{semanticCommitType}}{{#if semanticCommitScope}}({{semanticCommitScope}}){{/if}}: {{/if}}{{#if isPin}}Pin{{else}}Update{{/if}} dependency {{depName}} to version {{newVersion}} 🌟",
         "major": {"automerge": false},
         "minor": {"automerge": false},
         "prConcurrentLimit": 3,
         "prHourlyLimit": 2,
         "schedule": ["after 2am and before 3am on saturday"],
         "updateNotScheduled": false,
         "timezone": "America/New_York",
         "lockFileMaintenance": {"enabled": true},
         "separateMinorPatch": true,
         "separateMultipleMajor": true,
         "dependencyDashboard": true,
         "labels": ["type: dependencies", "renovate"],
         "packageRules": [
           {
             "matchPackageNames": ["cypress"],
             "groupName": "cypress",
             "schedule": "before 2am"
           },
           {"groupName": "eslint", "matchPackageNames": ["/^eslint/"]}
         ]
       }
 WARN: Found errors in configuration
       "file": "renovate.json",
       "warnings": [
         {
           "topic": "Deprecation Warning",
           "message": "Direct editing of commitMessage is now deprecated. Please edit commitMessage's subcomponents instead."
         },
         {
           "topic": "Deprecation Warning",
           "message": "Direct editing of prTitle is now deprecated. Please edit commitMessage subcomponents instead as they will be passed through to prTitle."
         }
       ]

Change

Update renovate.json according to recommendations from Renovate Config Validation.

1. Convert config:base to new name config:recommended
2. Remove the deprecated commitMessage and prTitle options. The defaults now provide adequate messages.
3. Remove masterIssue. This was replaced by dependencyDashboard and it is selected by default with config:recommended.
4. Convert separatePatchReleases to separateMinorPatch
5. Convert packageNames and packagePatterns to matchPackageNames
6. Change ^eslint to eslint to match all ESLint related packages and add globals.
7. Add configMigration true to automatically create config migration PRs when needed.

Verification

Execute

npx --yes --package renovate -- renovate-config-validator

and confirm output:

 INFO: Validating renovate.json
 INFO: Config validated successfully

Reference

• config:recommended
• Config Validation
• commitMessage
• configMigration
• dependencyDashboard
• matchPackageNames
• prTitle
• separateMinorPatch

[cypress-app-bot]

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

[jennifer-shehane]

Thanks! Definitely missed this notice here.

[MikeMcC399]

@jennifer-shehane

Thanks! Definitely missed this notice here.

It seems that nobody is using the Renovate Dependency Dashboard in this repo. I imagine that the notice has been there for about 2 years now according to when Renovate made changes to their parameters. It's not something that I can use, with Triage privileges, as this doesn't allow me to activate any of the selections in the Dashboard.

I notice that the renovate.json configuration has several autoMerge settings. This aren't very effective when GitHub branch protection rules requiring PR approvals are activated. Renovate can only autoMerge after a PR has been approved, and in the cases I looked at PRs have been manually approved, then manually merged, without waiting for Renovate to autoMerge. I'm not suggesting any change here, I just wanted to highlight it, as it was puzzling me for a while, how this is supposed to work, and I've only just now understood it.

The Renovate Dependency Dashboard has in any case now refreshed and no longer shows any config recommendations or errors: