Skip to content

Commit f7b98b9

Browse files
committed
Replace hardcoded OTel version with $otelVersion-alpha marker
The script strips the -alpha suffix so $otelVersion resolves to the base version (e.g. 2.24.0), and docs write $otelVersion-alpha explicitly to produce the full version string. Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
1 parent 00b0456 commit f7b98b9

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

.mise/tasks/set-release-version-github-pages.sh

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,8 @@
55
set -euox pipefail
66

77
version=$(git tag -l | grep 'v' | sort | tail -1 | sed 's/v//')
8-
marker="\$version"
9-
find ./docs/content -name '*.md' -exec sed -i "s/$marker/$version/g" {} +
8+
otelVersion=$(grep -oP '<otel.instrumentation.version>\K[^<]+' pom.xml | sed 's/-alpha$//')
9+
10+
find ./docs/content -name '*.md' \
11+
-exec sed -i "s/\$version/$version/g" {} + \
12+
-exec sed -i "s/\$otelVersion/$otelVersion/g" {} +

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ mise run lint:super-linter
123123

124124
- Docs live under `docs/content/` and use `$version` as a placeholder for the library version
125125
- When publishing GitHub Pages, `mise run set-release-version-github-pages` replaces `$version` with the latest git tag across all `docs/content/**/*.md` files (the published site is not versioned)
126-
- When writing docs, always use `$version` for the Prometheus client version — never hardcode it
126+
- Use `$version` for the Prometheus client version and `$otelVersion-alpha` for the OTel instrumentation version — never hardcode them
127127

128128
## Java Version
129129

docs/content/otel/jvm-runtime-metrics.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ implementation 'io.prometheus:prometheus-metrics-otel-support:$version'
3636
3737
// Use opentelemetry-runtime-telemetry-java8 (Java 8+)
3838
// or opentelemetry-runtime-telemetry-java17 (Java 17+, JFR-based)
39-
implementation 'io.opentelemetry.instrumentation:opentelemetry-runtime-telemetry-java8:2.24.0-alpha'
39+
implementation(
40+
'io.opentelemetry.instrumentation:opentelemetry-runtime-telemetry-java8:$otelVersion-alpha'
41+
)
4042
```
4143

4244
{{< /tab >}}
@@ -55,14 +57,14 @@ implementation 'io.opentelemetry.instrumentation:opentelemetry-runtime-telemetry
5557
<dependency>
5658
<groupId>io.opentelemetry.instrumentation</groupId>
5759
<artifactId>opentelemetry-runtime-telemetry-java8</artifactId>
58-
<version>2.24.0-alpha</version>
60+
<version>$otelVersion-alpha</version>
5961
</dependency>
6062
<!-- Java 17+ (adds JFR-based metrics) -->
6163
<!--
6264
<dependency>
6365
<groupId>io.opentelemetry.instrumentation</groupId>
6466
<artifactId>opentelemetry-runtime-telemetry-java17</artifactId>
65-
<version>2.24.0-alpha</version>
67+
<version>$otelVersion-alpha</version>
6668
</dependency>
6769
-->
6870
```

0 commit comments

Comments
 (0)