Merge pull request #658 from OctopusDeploy/sast/si/introduce-renovate-pr-comments

Introduce "Green-means-go" Renovate PR Messages

Author: samdanaei

renovate-config.js

@@ -1,44 +1,67 @@
+// Several parts of this config such as the excludeList, preCannedPrNotes and some packageRules have been duplicated from the Octopus Server renovate.config as they also apply to Tentacle
+// https://github.com/OctopusDeploy/OctopusDeploy/blob/main/renovate-config.js
+
 const excludeList = [
-    "dotnet-sdk", // The dotnet SDK update is a non-trivial piece of work
-    "FluentAssertions", // FluentAssertions 8 and above introduced potential fees for developers
-    "Halibut", // Various versions of Halibut are used for tests. We'll manually control this version
-];
+  'dotnet-sdk', // The dotnet SDK update is a non-trivial piece of work
+  'FluentAssertions', // FluentAssertions 8 and above introduced potential fees for developers
+  'Halibut', // Various versions of Halibut are used for tests. We'll manually control this version
+]
+
+const preCannedPrNotes = {
+  greenMeansGo: [
+    'Green means go. Any issues in this PR should be caught as part of our tests and/or builds.',
+  ],
+}
 
 module.exports = {
+  timezone: 'Australia/Brisbane',
+  requireConfig: 'optional',
+  onboarding: false,
+
+  ignoreDeps: excludeList,
+  enabledManagers: ['nuget'],
+
+  // Full list of built-in presets: https://docs.renovatebot.com/presets-default/
+  extends: [
+    'config:base',
+    'group:monorepos',
+    'group:recommended',
+    ':rebaseStalePrs',
+    ':automergeRequireAllStatusChecks',
+  ],
+
+  // Renovate will create a new issue in the repository.
+  // This issue has a "dashboard" where you can get an overview of the status of all updates.
+  // https://docs.renovatebot.com/key-concepts/dashboard/
+  dependencyDashboard: true,
+  dependencyDashboardTitle: 'Halibut Dependency Dashboard',
+
+  platform: 'github',
+  repositories: ['OctopusDeploy/Halibut'],
+  reviewers: ['OctopusDeploy/team-server-at-scale'],
+  labels: ['dependencies', 'Halibut'],
+  branchPrefix: 'renovate-dotnet/',
+
+  // Limit the amount of PRs created
+  prConcurrentLimit: 2,
+  prHourlyLimit: 1,
+
+  // If set to false, Renovate will upgrade dependencies to their latest release only. Renovate will not separate major or minor branches.
+  // https://docs.renovatebot.com/configuration-options/#separatemajorminor
+  separateMajorMinor: false,
+
+  packageRules: [
+    // Keep the rest of the packages in alphabetical order (of package name). However, non-greenMeansGo packages should be placed before greenMeansGo packages
+    // Non-greenMeansGo packages
+    // <None at the moment. Replace this comment when some are introduced>
 
-    timezone: "Australia/Brisbane",
-    requireConfig: "optional",
-    onboarding: false,
-
-    ignoreDeps: excludeList,
-    enabledManagers: ["nuget"],
-
-    // Full list of built-in presets: https://docs.renovatebot.com/presets-default/
-    extends: [
-        "config:base",
-        "group:monorepos",
-        "group:recommended",
-		":rebaseStalePrs",
-        ":automergeRequireAllStatusChecks",
-    ],
-
-    // Renovate will create a new issue in the repository.
-    // This issue has a "dashboard" where you can get an overview of the status of all updates.
-    // https://docs.renovatebot.com/key-concepts/dashboard/
-    dependencyDashboard: true,
-    dependencyDashboardTitle: "Halibut Dependency Dashboard",
-
-    platform: "github",
-    repositories: ["OctopusDeploy/Halibut"],
-    reviewers: ["OctopusDeploy/team-server-at-scale"],
-    labels: ["dependencies", "Halibut"],
-    branchPrefix: "renovate-dotnet/",
-
-    // Limit the amount of PRs created
-    prConcurrentLimit: 2,
-    prHourlyLimit: 1,
-
-    // If set to false, Renovate will upgrade dependencies to their latest release only. Renovate will not separate major or minor branches.
-    // https://docs.renovatebot.com/configuration-options/#separatemajorminor
-    separateMajorMinor: false,
-};
+    // greenMeansGo packages
+    {
+      matchPackageNames: ['Nsubstitute'],
+      prBodyNotes: [
+        ...preCannedPrNotes.greenMeansGo,
+        'Used extensively throughout tests. Any breaking changes are likely to be surfaced in the test suite.',
+      ],
+    },
+  ],
+}