restore comments

Author: trask

.github/renovate.json5

@@ -6,10 +6,11 @@
     'helpers:pinGitHubActionDigests',
   ],
   ignorePresets: [
-    ':ignoreModulesAndTests',
+    ':ignoreModulesAndTests', // needed to keep maven-extension test pom files up-to-date
   ],
   packageRules: [
     {
+      // this is to reduce the number of renovate PRs
       matchManagers: [
         'github-actions',
         'dockerfile',
@@ -26,15 +27,20 @@
         'io.opentelemetry.semconv:**',
         'io.opentelemetry.proto:**',
       ],
+      // Renovate's default behavior is only to update from unstable -> unstable if it's for the
+      // major.minor.patch, under the assumption that you would want to update to the stable version
+      // of that release instead of the unstable version for a future release
       ignoreUnstable: false,
     },
     {
+      // prevent 3.0.1u2 -> 3.0.1
       matchPackageNames: [
         'com.google.code.findbugs:annotations',
       ],
       allowedVersions: '!/^3\\.0\\.1$/',
     },
     {
+      // disruptor 4+ requires Java 11+
       matchPackageNames: [
         'com.lmax:disruptor',
       ],
@@ -44,6 +50,7 @@
       enabled: false,
     },
     {
+      // junit-pioneer 2+ requires Java 11+
       matchPackageNames: [
         'org.junit-pioneer:junit-pioneer',
       ],
@@ -53,6 +60,7 @@
       enabled: false,
     },
     {
+      // mockito 5+ requires Java 11+
       matchUpdateTypes: [
         'major',
       ],
@@ -62,6 +70,7 @@
       ],
     },
     {
+      // agrona 1.23+ requires Java 17+
       matchPackageNames: [
         'org.agrona:agrona',
       ],
@@ -72,6 +81,7 @@
       enabled: false,
     },
     {
+      // system-stubs-jupiter 2.1+ requires Java 11+
       matchPackageNames: [
         'uk.org.webcompere:system-stubs-jupiter',
       ],
@@ -82,13 +92,15 @@
       enabled: false,
     },
     {
+      // pinned version for compatibility
       matchPackageNames: [
         'io.micrometer:micrometer-core',
       ],
       matchCurrentVersion: '1.5.0',
       enabled: false,
     },
     {
+      // pinned version for compatibility
       matchCurrentVersion: '3.5.0',
       enabled: false,
       matchPackageNames: [
@@ -102,6 +114,7 @@
       ],
     },
     {
+      // pinned version for compatibility with java 8 JFR parsing
       matchUpdateTypes: [
         'major',
       ],
@@ -111,6 +124,7 @@
       ],
     },
     {
+      // pinned version for compatibility
       matchFileNames: [
         'jmx-scraper/test-webapp/build.gradle.kts',
       ],
@@ -121,6 +135,7 @@
       ],
     },
     {
+      // intentionally using Spring Boot 2 in gcp-auth-extension in order to test with Java 8+
       matchFileNames: [
         'gcp-auth-extension/build.gradle.kts',
       ],