Skip to content

Commit 5d529a5

Browse files
authored
Update readme post 1.24.0 release (#60)
1 parent 26b3f13 commit 5d529a5

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ details. Additionally, the [README](README.md) contains useful information that
1414
which are stable (the artifact itself is not yet stable but we aim to stabilize eventually),
1515
and `io.opentelemetry.semconv:opentelemetry-semconv-incubating:{{version}}` for semantic
1616
conventions which are incubating (experimental) (this artifact will always have the `-alpha`
17-
designation). As a part of this restructuring, old attributes which do not exist
18-
in [semantic-conventions](https://github.com/open-telemetry/semantic-conventions), but which we
19-
had retained manually with deprecated annotations, have been removed.
17+
designation). As a part of this restructuring, old attributes which were removed from
18+
[semantic-conventions](https://github.com/open-telemetry/semantic-conventions) (without being
19+
deprecated there) have been removed.
2020
([#41](https://github.com/open-telemetry/semantic-conventions-java/pull/41))
2121
* BREAKING: Generate classes by root namespace. Where previously all attributes were contained in
2222
two classes, `ResourceAttributes` and `SemanticAttributes`, they are now organized by their root

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Java code-generation for the [OpenTelemetry Semantic Conventions](https://github
77

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

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. |
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}}` | [![Maven Central][maven-image-incubating]][maven-url-incubating] | 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. |
1414

1515

1616
### Maven
@@ -89,6 +89,8 @@ for code owners.
8989
[ci-url]: https://github.com/open-telemetry/semantic-conventions-java/actions?query=workflow%3Abuild+branch%3Amain
9090
[maven-image-stable]: https://maven-badges.herokuapp.com/maven-central/io.opentelemetry.semconv/opentelemetry-semconv/badge.svg
9191
[maven-url-stable]: https://maven-badges.herokuapp.com/maven-central/io.opentelemetry.semconv/opentelemetry-semconv
92+
[maven-image-incubating]: https://maven-badges.herokuapp.com/maven-central/io.opentelemetry.semconv/opentelemetry-semconv-incubating/badge.svg
93+
[maven-url-incubating]: https://maven-badges.herokuapp.com/maven-central/io.opentelemetry.semconv/opentelemetry-semconv-incubating
9294
[versioning]: https://github.com/open-telemetry/opentelemetry-java/blob/main/VERSIONING.md
9395

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

0 commit comments

Comments
 (0)