Skip to content

Commit 5890c81

Browse files
authored
README.md updates post stable release (#150)
* README.md updates post stable release * Add 1.30.0 entry to changelog
1 parent 0ebefbf commit 5890c81

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
## Unreleased
44

5+
## Version 1.30.0 (2025-02-18)
6+
7+
See [1.30.0-rc.1](#version-1300-rc1-2025-01-27). No additional changes.
8+
59
## Version 1.30.0-rc.1 (2025-01-27)
610

711
**NOTICE**: This is a release candidate (RC), preceding the first stable release of `io.opentelemetry.semconv:opentelemetry-semconv`.

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,17 @@ Java code-generation for the [OpenTelemetry Semantic Conventions](https://github
1212

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

15-
| Artifact `{group}:{artifactId}:{version}` | Latest Version | Description |
16-
|-------------------------------------------------------------------------|------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
17-
| `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. |
18-
| `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. |
15+
| Artifact `{group}:{artifactId}:{version}` | Latest Version | Description |
16+
|-------------------------------------------------------------------------------|------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
17+
| `io.opentelemetry.semconv:opentelemetry-semconv:{{version}}` | [![Maven Central][maven-image-stable]][maven-url-stable] | Generated code for stable semantic conventions. |
18+
| `io.opentelemetry.semconv:opentelemetry-semconv-incubating:{{version}}-alpha` | [![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. |
1919

2020

2121
### Maven
2222

2323
```xml
2424
<project>
2525
<dependencies>
26-
<!-- Stable semantic conventions. Note: generated code is still subject to breaking changes while published with "-alpha" suffix. -->
2726
<dependency>
2827
<groupId>io.opentelemetry.semconv</groupId>
2928
<artifactId>opentelemetry-semconv</artifactId>
@@ -33,7 +32,7 @@ Published releases are available on maven central. Replace `{{version}}` with th
3332
<dependency>
3433
<groupId>io.opentelemetry.semconv</groupId>
3534
<artifactId>opentelemetry-semconv-incubating</artifactId>
36-
<version>{{version}}</version>
35+
<version>{{version}}-alpha</version>
3736
</dependency>
3837
</dependencies>
3938
</project>
@@ -43,10 +42,9 @@ Published releases are available on maven central. Replace `{{version}}` with th
4342

4443
```groovy
4544
dependencies {
46-
// Stable semantic conventions. Note: generated code is still subject to breaking changes while published with "-alpha" suffix.
4745
implementation "io.opentelemetry.semconv:opentelemetry-semconv:{{version}}"
4846
// Incubating semantic conventions. Breaking changes expected. Library instrumentation SHOULD NOT depend on this.
49-
implementation "io.opentelemetry.semconv:opentelemetry-semconv-incubating:{{version}}"
47+
implementation "io.opentelemetry.semconv:opentelemetry-semconv-incubating:{{version}}-alpha"
5048
}
5149
```
5250

@@ -71,9 +69,9 @@ pull request on the OpenTelemetry Android Extension for details.
7169

7270
Artifacts from this repository follow semantic versioning, mirroring the versions of the upstream [semantic-conventions](https://github.com/open-telemetry/semantic-conventions) repository. If a patch release is needed for logic in this repository, a release will be published with a fourth version component (i.e. `1.30.0.1` to patch an issue with `1.30.0`).
7371

74-
Stable artifacts (i.e. artifacts without -alpha version suffix) come with strong backwards compatibility guarantees for public APIs.
72+
Stable artifacts (i.e. artifacts without `-alpha` version suffix) come with strong backwards compatibility guarantees for public APIs.
7573

76-
Compatibility guarantees are inherited from [opentelemetry-java](https://github.com/open-telemetry/opentelemetry-java/blob/main/VERSIONING.md).
74+
Compatibility guarantees are inherited from [opentelemetry-java][versioning].
7775

7876
## Generating semantic conventions
7977

0 commit comments

Comments
 (0)