Skip to content

Commit a411d9a

Browse files
authored
Update readme to reflect new artifact strategy (#53)
1 parent 379efda commit a411d9a

File tree

3 files changed

+9
-23
lines changed

3 files changed

+9
-23
lines changed

README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# OpenTelemetry Semantic Conventions for Java
22
[![Continuous Build][ci-image]][ci-url]
3-
[![Maven Central][maven-image]][maven-url]
43

54
Java code-generation for the [OpenTelemetry Semantic Conventions](https://github.com/open-telemetry/semantic-conventions).
65

76
## Published released
87

98
Published releases are available on maven central. Replace `{{version}}` with the latest released version:
109

11-
[![Maven Central][maven-image]][maven-url]
10+
| Artifact `{group}:{artifcatId}:{version}` | Latest Version | Description |
11+
|-------------------------------------------------------------------------|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
12+
| `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+
1215

1316
### Maven
1417

@@ -67,23 +70,6 @@ of [open-telemetry/semantic-conventions](https://github.com/open-telemetry/seman
6770
defined in the `semanticConventionsVersion` variable of [build.gradle.kts](./build.gradle.kts) and
6871
generate semantic conventions classes from the release contents.
6972

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.
86-
8773
## Contributing
8874

8975
Before you start - see OpenTelemetry
@@ -101,7 +87,8 @@ for code owners.
10187

10288
[ci-image]: https://github.com/open-telemetry/semantic-conventions-java/workflows/Build/badge.svg
10389
[ci-url]: https://github.com/open-telemetry/semantic-conventions-java/actions?query=workflow%3Abuild+branch%3Amain
104-
[maven-image]: https://maven-badges.herokuapp.com/maven-central/io.opentelemetry.semconv/opentelemetry-semconv/badge.svg
105-
[maven-url]: https://maven-badges.herokuapp.com/maven-central/io.opentelemetry.semconv/opentelemetry-semconv
90+
[maven-image-stable]: https://maven-badges.herokuapp.com/maven-central/io.opentelemetry.semconv/opentelemetry-semconv/badge.svg
91+
[maven-url-stable]: https://maven-badges.herokuapp.com/maven-central/io.opentelemetry.semconv/opentelemetry-semconv
92+
[versioning]: https://github.com/open-telemetry/opentelemetry-java/blob/main/VERSIONING.md
10693

10794
TODO(jack-berg): add code coverage badge?

semconv-incubating/build.gradle.kts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
plugins {
22
id("otel.java-conventions")
33
id("otel.publish-conventions")
4-
id("otel.japicmp-conventions")
54

65
id("otel.animalsniffer-conventions")
76
}

semconv/build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
plugins {
22
id("otel.java-conventions")
33
id("otel.publish-conventions")
4-
// TODO: re-enable japicmp when done with breaking changes
4+
// TODO: re-enable japicmp when artifact is stable
55
// id("otel.japicmp-conventions")
66

77
id("otel.animalsniffer-conventions")

0 commit comments

Comments
 (0)