Restore comments

Author: trask

.github/renovate.json5

@@ -5,15 +5,17 @@
     'helpers:pinGitHubActionDigestsToSemver',
   ],
   ignorePresets: [
-    ':ignoreModulesAndTests',
-    'workarounds:javaLTSVersions',
+    ':ignoreModulesAndTests', // needed to keep maven-extension test pom files up-to-date
+    'workarounds:javaLTSVersions', // Allow all Java major versions, not just LTS
   ],
-  prHourlyLimit: 5,
+  prHourlyLimit: 5, // we have a large number of parallel runners
   labels: [
     'dependencies',
   ],
   packageRules: [
     {
+      // reduces the number of Renovate PRs
+      // (patch updates are typically non-breaking)
       groupName: 'all patch versions',
       matchUpdateTypes: [
         'patch',
@@ -23,6 +25,8 @@
       ],
     },
     {
+      // avoids these Renovate PRs from trickling in throughout the week
+      // (consolidating the review process)
       matchUpdateTypes: [
         'minor',
         'major',
@@ -42,15 +46,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',
       ],
@@ -60,6 +69,7 @@
       enabled: false,
     },
     {
+      // junit-pioneer 2+ requires Java 11+
       matchPackageNames: [
         'org.junit-pioneer:junit-pioneer',
       ],
@@ -69,6 +79,7 @@
       enabled: false,
     },
     {
+      // mockito 5+ requires Java 11+
       matchUpdateTypes: [
         'major',
       ],
@@ -78,6 +89,7 @@
       ],
     },
     {
+      // agrona 1.23+ requires Java 17+
       matchPackageNames: [
         'org.agrona:agrona',
       ],
@@ -88,6 +100,7 @@
       enabled: false,
     },
     {
+      // system-stubs-jupiter 2.1+ requires Java 11+
       matchPackageNames: [
         'uk.org.webcompere:system-stubs-jupiter',
       ],
@@ -98,13 +111,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: [
@@ -130,6 +145,7 @@
       ],
     },
     {
+      // pinned version for compatibility with java 8 JFR parsing
       matchUpdateTypes: [
         'major',
       ],
@@ -139,6 +155,7 @@
       ],
     },
     {
+      // pinned version for compatibility
       matchFileNames: [
         'jmx-scraper/test-webapp/build.gradle.kts',
       ],
@@ -149,6 +166,7 @@
       ],
     },
     {
+      // intentionally using Spring Boot 2 in gcp-auth-extension in order to test with Java 8+
       matchFileNames: [
         'gcp-auth-extension/build.gradle.kts',
       ],