Skip to content

Commit

Permalink
Update the docs for the 1.7.0 release. (#3715)
Browse files Browse the repository at this point in the history
* Update the docs for the 1.7.0 release.

* formatting
  • Loading branch information
jkwatson authored Oct 8, 2021
1 parent b77c2b9 commit a8a27f4
Show file tree
Hide file tree
Showing 32 changed files with 2,825 additions and 2,774 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Changelog

## Version 1.7.0 (unreleased):
## Version 1.8.0 (unreleased):

---
## Version 1.7.0 (2021-10-08):

### General

Expand Down Expand Up @@ -60,6 +63,7 @@
implementations for batch log processing and export via OTLP. These classes are intended for usage
in implementations of log appenders that emit OTLP log entries.

---
## Version 1.6.0 (2021-09-13):

### API
Expand Down
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ dependency versions in sync.
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-bom</artifactId>
<version>1.6.0</version>
<version>1.7.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand All @@ -106,7 +106,7 @@ dependency versions in sync.

```groovy
dependencies {
implementation platform("io.opentelemetry:opentelemetry-bom:1.6.0")
implementation platform("io.opentelemetry:opentelemetry-bom:1.7.0")
implementation('io.opentelemetry:opentelemetry-api')
}
```
Expand All @@ -115,8 +115,8 @@ Note that if you want to use any artifacts that have not fully stabilized yet (s

```groovy
dependencies {
implementation platform("io.opentelemetry:opentelemetry-bom:1.6.0")
implementation platform('io.opentelemetry:opentelemetry-bom-alpha:1.6.0-alpha')
implementation platform("io.opentelemetry:opentelemetry-bom:1.7.0")
implementation platform('io.opentelemetry:opentelemetry-bom-alpha:1.7.0-alpha')
implementation('io.opentelemetry:opentelemetry-api')
implementation('io.opentelemetry:opentelemetry-api-metrics')
Expand All @@ -143,7 +143,7 @@ We strongly recommend using our published BOM to keep all dependency versions in
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-bom</artifactId>
<version>1.6.0-SNAPSHOT</version>
<version>1.8.0-SNAPSHOT</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand All @@ -166,7 +166,7 @@ repositories {
}
dependencies {
implementation platform("io.opentelemetry:opentelemetry-bom:1.6.0-SNAPSHOT")
implementation platform("io.opentelemetry:opentelemetry-bom:1.8.0-SNAPSHOT")
implementation('io.opentelemetry:opentelemetry-api')
}
```
Expand All @@ -192,19 +192,20 @@ This is a **current** feature status list:

| Component | Version |
| --------------------------- | ------- |
| Trace API | v<!--VERSION_STABLE-->1.6.0<!--/VERSION_STABLE--> |
| Trace SDK | v<!--VERSION_STABLE-->1.6.0<!--/VERSION_STABLE--> |
| Context | v<!--VERSION_STABLE-->1.6.0<!--/VERSION_STABLE--> |
| Baggage | v<!--VERSION_STABLE-->1.6.0<!--/VERSION_STABLE--> |
| Jaeger Trace Exporter | v<!--VERSION_STABLE-->1.6.0<!--/VERSION_STABLE--> |
| Zipkin Trace Exporter | v<!--VERSION_STABLE-->1.6.0<!--/VERSION_STABLE--> |
| OTLP Exporter (Spans) | v<!--VERSION_STABLE-->1.6.0<!--/VERSION_STABLE--> |
| OTLP Exporter (Metrics) | v<!--VERSION_UNSTABLE-->1.6.0-alpha<!--/VERSION_UNSTABLE--> |
| Metrics API | v<!--VERSION_UNSTABLE-->1.6.0-alpha<!--/VERSION_UNSTABLE--> |
| Metrics SDK | v<!--VERSION_UNSTABLE-->1.6.0-alpha<!--/VERSION_UNSTABLE--> |
| Prometheus Metrics Exporter | v<!--VERSION_UNSTABLE-->1.6.0-alpha<!--/VERSION_UNSTABLE--> |
| OpenTracing Bridge | v<!--VERSION_UNSTABLE-->1.6.0-alpha<!--/VERSION_UNSTABLE--> |
| OpenCensus Bridge | v<!--VERSION_UNSTABLE-->1.6.0-alpha<!--/VERSION_UNSTABLE--> |
| Trace API | v<!--VERSION_STABLE-->1.7.0<!--/VERSION_STABLE--> |
| Trace SDK | v<!--VERSION_STABLE-->1.7.0<!--/VERSION_STABLE--> |
| Context | v<!--VERSION_STABLE-->1.7.0<!--/VERSION_STABLE--> |
| Baggage | v<!--VERSION_STABLE-->1.7.0<!--/VERSION_STABLE--> |
| Jaeger Trace Exporter | v<!--VERSION_STABLE-->1.7.0<!--/VERSION_STABLE--> |
| Zipkin Trace Exporter | v<!--VERSION_STABLE-->1.7.0<!--/VERSION_STABLE--> |
| OTLP Exporter (Spans) | v<!--VERSION_STABLE-->1.7.0<!--/VERSION_STABLE--> |
| OTLP Exporter (Metrics) | v<!--VERSION_UNSTABLE-->1.7.0-alpha<!--/VERSION_UNSTABLE--> |
| Metrics API | v<!--VERSION_UNSTABLE-->1.7.0-alpha<!--/VERSION_UNSTABLE--> |
| Metrics SDK | v<!--VERSION_UNSTABLE-->1.7.0-alpha<!--/VERSION_UNSTABLE--> |
| Logs SDK | v<!--VERSION_UNSTABLE-->1.7.0-alpha<!--/VERSION_UNSTABLE--> |
| Prometheus Metrics Exporter | v<!--VERSION_UNSTABLE-->1.7.0-alpha<!--/VERSION_UNSTABLE--> |
| OpenTracing Bridge | v<!--VERSION_UNSTABLE-->1.7.0-alpha<!--/VERSION_UNSTABLE--> |
| OpenCensus Bridge | v<!--VERSION_UNSTABLE-->1.7.0-alpha<!--/VERSION_UNSTABLE--> |

See the project [milestones](https://github.com/open-telemetry/opentelemetry-java/milestones)
for details on upcoming releases. The dates and features described in issues
Expand Down
4 changes: 1 addition & 3 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,7 @@ Next, update the

Create a PR to mark the new release in README.md and CHANGELOG.md on the main branch.

Finally, update the files `website_docs` directory to point at the newly released version. Once that has
been merged to the main branch, use the "Update OpenTelemetry Website" github action to create a PR
in the website repository with the changes.
Finally, update the files `website_docs` directory to point at the newly released version.

## Patch Release

Expand Down
24 changes: 24 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,27 @@ tasks.register("generateBuildSubstitutions") {
subprojects {
group = "io.opentelemetry"
}

tasks {
register("updateVersionInDocs") {
group = "documentation"
doLast {
val versionParts = version.toString().split('.')
val minorVersionNumber = Integer.parseInt(versionParts[1])
val nextSnapshot = "${versionParts[0]}.${minorVersionNumber + 1}.0-SNAPSHOT"

val readme = file("README.md")
if (readme.exists()) {
val readmeText = readme.readText()
val updatedText = readmeText
.replace("""<version>\d+\.\d+\.\d+</version>""".toRegex(), "<version>$version</version>")
.replace("""<version>\d+\.\d+\.\d+-SNAPSHOT</version>""".toRegex(), "<version>$nextSnapshot</version>")
.replace("""(implementation.*io\.opentelemetry:.*:)(\d+\.\d+\.\d+)(?!-SNAPSHOT)(.*)""".toRegex(), "\$1${version}\$3")
.replace("""(implementation.*io\.opentelemetry:.*:)(\d+\.\d+\.\d+-SNAPSHOT)(.*)""".toRegex(), "\$1${nextSnapshot}\$3")
.replace("""<!--VERSION_STABLE-->.*<!--/VERSION_STABLE-->""".toRegex(), "<!--VERSION_STABLE-->$version<!--/VERSION_STABLE-->")
.replace("""<!--VERSION_UNSTABLE-->.*<!--/VERSION_UNSTABLE-->""".toRegex(), "<!--VERSION_UNSTABLE-->$version-alpha<!--/VERSION_UNSTABLE-->")
readme.writeText(updatedText)
}
}
}
}
24 changes: 0 additions & 24 deletions buildSrc/src/main/kotlin/otel.publish-conventions.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -77,27 +77,3 @@ if (System.getenv("CI") != null) {
sign(publishing.publications["mavenPublication"])
}
}

tasks {
register("updateVersionInDocs") {
group = "documentation"
doLast {
val versionParts = version.toString().split('.')
val minorVersionNumber = Integer.parseInt(versionParts[1])
val nextSnapshot = "${versionParts[0]}.${minorVersionNumber + 1}.0-SNAPSHOT"

val readme = file("README.md")
if (readme.exists()) {
val readmeText = readme.readText()
val updatedText = readmeText
.replace("""<version>\d+\.\d+\.\d+</version>""".toRegex(), "<version>${version}</version>")
.replace("""<version>\d+\.\d+\.\d+-SNAPSHOT</version>""".toRegex(), "<version>${nextSnapshot}</version>")
.replace("""(implementation.*io\.opentelemetry:.*:)(\d+\.\d+\.\d+)(?!-SNAPSHOT)(.*)""".toRegex(), "\$1${version}\$3")
.replace("""(implementation.*io\.opentelemetry:.*:)(\d+\.\d+\.\d+-SNAPSHOT)(.*)""".toRegex(), "\$1${nextSnapshot}\$3")
.replace("""<!--VERSION_STABLE-->.*<!--/VERSION_STABLE-->""".toRegex(), "<!--VERSION_STABLE-->${version}<!--/VERSION_STABLE-->")
.replace("""<!--VERSION_UNSTABLE-->.*<!--/VERSION_UNSTABLE-->""".toRegex(), "<!--VERSION_UNSTABLE-->${version}-alpha<!--/VERSION_UNSTABLE-->")
readme.writeText(updatedText)
}
}
}
}
2 changes: 2 additions & 0 deletions docs/apidiffs/1.7.0_vs_1.6.0/opentelemetry-api.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.
2 changes: 2 additions & 0 deletions docs/apidiffs/1.7.0_vs_1.6.0/opentelemetry-context.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Comparing source compatibility of against
No changes.
Loading

0 comments on commit a8a27f4

Please sign in to comment.