bring back comments

Author: trask

.github/renovate.json5

@@ -8,6 +8,10 @@
   ignorePaths: [
     'instrumentation/**',
   ],
+  // needed in order to get patch-only updates in package rules below
+  // unfortunately you can't combine updateTypes and separateMinorPatch in the same package rule
+  // so we have to apply it globally here, see
+  // https://github.com/renovatebot/renovate/discussions/8399#discussioncomment-305798
   separateMinorPatch: true,
   packageRules: [
     {
@@ -19,7 +23,7 @@
         'schedule:weekly',
       ],
       groupName: 'weekly update',
-      separateMinorPatch: false,
+      separateMinorPatch: false,  // overrides separateMinorPatch specified above
     },
     {
       matchPackageNames: [
@@ -30,6 +34,10 @@
         'io.opentelemetry.proto:opentelemetry-proto',
         'io.opentelemetry.semconv:opentelemetry-semconv',
       ],
+      // 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
+      // (TODO remove once the artifacts above release stable versions)
       ignoreUnstable: false,
       allowedVersions: '!/\\-SNAPSHOT$/',
     },
@@ -70,24 +78,28 @@
       ],
     },
     {
+      // prevent update to 2.4-groovy-4.0-SNAPSHOT
       allowedVersions: '!/\\-SNAPSHOT$/',
       matchPackageNames: [
         'org.spockframework:{/,}**',
       ],
     },
     {
+      // prevent 3.0.1u2 -> 3.0.1
       matchPackageNames: [
         'com.google.code.findbugs:annotations',
       ],
       allowedVersions: '!/3\\.0\\.1$/',
     },
     {
+      // OpenTelemetry SDK updates are handled by auto-update-otel-sdk.yml
       enabled: false,
       matchPackageNames: [
         'io.opentelemetry:{/,}**',
       ],
     },
     {
+      // junit-pioneer 2+ requires Java 11+
       matchPackageNames: [
         'org.junit-pioneer:junit-pioneer',
       ],
@@ -97,6 +109,7 @@
       enabled: false,
     },
     {
+      // mockito 5+ requires Java 11+
       matchUpdateTypes: [
         'major',
       ],
@@ -106,6 +119,7 @@
       ],
     },
     {
+      // system-stubs-jupiter 2.1+ requires Java 11+
       matchPackageNames: [
         'uk.org.webcompere:system-stubs-jupiter',
       ],
@@ -116,6 +130,9 @@
       enabled: false,
     },
     {
+      // intentionally using Spring Boot 2 in this smoke tests
+      // new versions of Spring Boot 3 are tested with
+      // https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/dc4330e0a3060bd7d8c4090ad0b8fc4727e68113/settings.gradle.kts#L43-L45
       matchFileNames: [
         'smoke-tests/images/spring-boot/build.gradle.kts',
         'smoke-tests-otel-starter/spring-boot-2/build.gradle.kts',
@@ -126,7 +143,7 @@
       ],
       matchPackageNames: [
         'org.slf4j:slf4j-api',
-        'org.springframework.boot:org.springframework.boot.gradle.plugin',
+        'org.springframework.boot:org.springframework.boot.gradle.plugin', // this is for plugin id "org.springframework.boot"
         'org.springframework.boot:spring-boot-dependencies',
       ],
       matchUpdateTypes: [
@@ -136,6 +153,7 @@
       enabled: false,
     },
     {
+      // intentionally using Spring Boot 2 in this smoke tests
       matchFileNames: [
         'smoke-tests-otel-starter/spring-boot-2/build.gradle.kts',
         'smoke-tests-otel-starter/spring-boot-reactive-2/build.gradle.kts',
@@ -149,6 +167,7 @@
       enabled: false,
     },
     {
+      // intentionally using logback 1.2 in this smoke tests
       matchFileNames: [
         'smoke-tests/images/spring-boot/build.gradle.kts',
       ],
@@ -162,6 +181,7 @@
       ],
     },
     {
+      // intentionally using slf4j 1 in this smoke tests
       matchFileNames: [
         'smoke-tests/images/spring-boot/build.gradle.kts',
       ],
@@ -174,6 +194,8 @@
       ],
     },
     {
+      // intentionally pinning specifically to guice 5 in the play smoke test
+      // until we are able to test against the latest version of play
       matchFileNames: [
         'smoke-tests/images/play/build.gradle.kts',
       ],
@@ -187,6 +209,7 @@
       ],
     },
     {
+      // intentionally aligning both netty 4.0 and 4.1 version in this convention
       matchFileNames: [
         'conventions/src/main/kotlin/otel.java-conventions.gradle.kts',
       ],
@@ -200,6 +223,7 @@
       enabled: false,
     },
     {
+      // intentionally using scala 2.11 in otel.scala-conventions.gradle.kts
       matchFileNames: [
         'conventions/src/main/kotlin/otel.scala-conventions.gradle.kts',
       ],
@@ -213,6 +237,7 @@
       enabled: false,
     },
     {
+      // intentionally using Java 11 in some examples
       matchPackageNames: [
         'eclipse-temurin',
       ],
@@ -222,27 +247,31 @@
       enabled: false,
     },
     {
+      // using old version of this obscure artifact to test instrumentation of Java 1.1 bytecode
       matchPackageNames: [
         'net.sf.jt400:jt400',
       ],
       matchCurrentVersion: '6.1',
       enabled: false,
     },
     {
+      // pinned version for compatibility
       matchPackageNames: [
         'javax.servlet:javax.servlet-api',
       ],
       matchCurrentVersion: '3.0.1',
       enabled: false,
     },
     {
+      // pinned version for compatibility
       matchPackageNames: [
         'jakarta.servlet:jakarta.servlet-api',
       ],
       matchCurrentVersion: '5.0.0',
       enabled: false,
     },
     {
+      // intentionally using logback 1.3 in dependency management (for Java 8 support)
       matchFileNames: [
         'dependencyManagement/build.gradle.kts',
       ],
@@ -256,6 +285,7 @@
       ],
     },
     {
+      // intentionally using Spring Boot 2 in dependency management (for Java 8 support)
       matchFileNames: [
         'dependencyManagement/build.gradle.kts',
       ],
@@ -268,6 +298,7 @@
       ],
     },
     {
+      // pinned version to Jetty 8 (Servlet 3.0) for compatibility
       matchFileNames: [
         'examples/distro/instrumentation/servlet-3/build.gradle',
       ],