You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`io.opentelemetry.semconv:opentelemetry-semconv:{{version}}`|[![Maven Central][maven-image-stable]][maven-url-stable]| Generated code for stable semantic conventions.</br>**NOTE:** Although this is for stable semantic conventions, the artifact still has the [-alpha][versioning] and comes with no compatibility guarantees. The goal is to mark this artifact stable. |
13
+
|`io.opentelemetry.semconv:opentelemetry-semconv-incubating:{{version}}`| TODO: add badge after first publish | Generated code for experimental semantic conventions.</br>**NOTE:** This artifact has the [-alpha][versioning] and comes with no compatibility guarantees. Libraries can use this for testing, but should make copies of the attributes to avoid possible runtime errors from version conflicts. |
14
+
12
15
13
16
### Maven
14
17
@@ -67,23 +70,6 @@ of [open-telemetry/semantic-conventions](https://github.com/open-telemetry/seman
67
70
defined in the `semanticConventionsVersion` variable of [build.gradle.kts](./build.gradle.kts) and
68
71
generate semantic conventions classes from the release contents.
69
72
70
-
TODO: Update the following paragraph with new strategy for managing compatibility
71
-
72
-
This repository publishes `-alpha` artifacts and as discussed
73
-
in [opentelemetry-java/VERSIONING.md](https://github.com/open-telemetry/opentelemetry-java/blob/main/VERSIONING.md),
74
-
we make no compatibility guarantees. However, by convention we've been keeping attribute constants
75
-
around with `@Deprecated` annotation while we work towards formalizing the strategy (
76
-
see [#6](https://github.com/open-telemetry/semantic-conventions-java/issues/6)). The process for
77
-
retaining removed attributes is to carefully add entries to
78
-
the [SemanticAttributes.java.j2](./buildscripts/templates/SemanticAttributes.java.j2) template. This
79
-
is meticulous and error prone, hence the desire to fix it. To ensure we don't accidentally delete
80
-
any constants while we work our a permanent
81
-
strategy, [japicmp](./buildSrc/src/main/kotlin/otel.japicmp-conventions.gradle.kts) has been added
82
-
as a build check. It will ensure that only binary / source compatible changes are made. **NOTE: this
83
-
checking of binary / source compatibility is not required and will change in the future.**
84
-
85
-
To check compatibility, run `./gradlew build` after updating the template and running the generation task as documented above.
0 commit comments