Compile only opentelemetry-api dependency (#30)

jack-berg · web-flow · commit f128291856f4 · 2023-10-26T10:36:40.000-05:00
diff --git a/README.md b/README.md
@@ -37,6 +37,10 @@ dependencies {
 Java 17 or higher is required to build the projects in this repository. The built artifacts can be
 used on Java 8 or higher.
 
+To use this artifact you must also depend on `io.opentelemetry:opentelemetry-api:{{version}}`.
+See [opentelemetry-java releases](https://github.com/open-telemetry/opentelemetry-java#releases) for
+more information.
+
 ## Generating semantic conventions
 
 Requires docker.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -54,9 +54,12 @@ nexusPublishing {
   }
 }
 
+val opentelemetryJavaVersion = "1.31.0"
+
 dependencies {
-  implementation(platform("io.opentelemetry:opentelemetry-bom:1.31.0"))
-  implementation("io.opentelemetry:opentelemetry-api")
+  compileOnly("io.opentelemetry:opentelemetry-api:$opentelemetryJavaVersion")
+
+  testImplementation("io.opentelemetry:opentelemetry-api:$opentelemetryJavaVersion")
 
   testImplementation(platform("org.junit:junit-bom:5.10.0"))
   testImplementation("org.junit.jupiter:junit-jupiter-api")

Original file line number	Diff line number	Diff line change
`@@ -54,9 +54,12 @@ nexusPublishing {`
`54`	`54`	`}`
`55`	`55`	`}`
`56`	`56`
	`57`	`+val opentelemetryJavaVersion = "1.31.0"`
	`58`	`+`
`57`	`59`	`dependencies {`
`58`		`- implementation(platform("io.opentelemetry:opentelemetry-bom:1.31.0"))`
`59`		`- implementation("io.opentelemetry:opentelemetry-api")`
	`60`	`+ compileOnly("io.opentelemetry:opentelemetry-api:$opentelemetryJavaVersion")`
	`61`	`+`
	`62`	`+ testImplementation("io.opentelemetry:opentelemetry-api:$opentelemetryJavaVersion")`
`60`	`63`
`61`	`64`	`testImplementation(platform("org.junit:junit-bom:5.10.0"))`
`62`	`65`	`testImplementation("org.junit.jupiter:junit-jupiter-api")`