From d4c575cb42fed021840414ef7a5beb0bb8276cc6 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 8 Apr 2026 15:26:53 -0700 Subject: [PATCH 1/2] [DOCS] Test bundle descriptions --- docs/changelog.yml | 1 + docs/changelog/1017.yaml | 98 ++++++++++++++++++++++++++ docs/release-notes/breaking-changes.md | 4 ++ docs/release-notes/deprecations.md | 6 +- docs/release-notes/index.md | 5 ++ docs/release-notes/known-issues.md | 5 ++ docs/releases/1.10.0.yaml | 22 +++--- 7 files changed, 132 insertions(+), 9 deletions(-) create mode 100644 docs/changelog/1017.yaml diff --git a/docs/changelog.yml b/docs/changelog.yml index 30b5d297e..038180cd4 100644 --- a/docs/changelog.yml +++ b/docs/changelog.yml @@ -27,6 +27,7 @@ pivot: known-issue: regression: security: + other: rules: create: diff --git a/docs/changelog/1017.yaml b/docs/changelog/1017.yaml new file mode 100644 index 000000000..d6c3fbfcb --- /dev/null +++ b/docs/changelog/1017.yaml @@ -0,0 +1,98 @@ +##### Required fields ##### + +# title: +# A required string that is a short, user-facing headline. +# (Max 80 characters) + +# type: +# A required string that contains the type of change +# It can be one of: +# - breaking-change +# - bug-fix +# - deprecation +# - feature +# - enhancement +# - docs +# - known-issue +# - regression +# - security +# - other + +# products: +# A required array of objects that denote the affected products +# Each product object contains: +# +# - product: +# A required string with a valid product ID. +# Valid values are defined in https://github.com/elastic/docs-builder/blob/main/config/products.yml +# +# target: +# An optional string with the target version or date. +# +# lifecycle: +# An optional string for new features or enhancements that have a specific availability. +# It can be one of: +# - preview +# - beta +# - ga + +##### Optional fields ##### + +# action: +# An optional string that describes what users must do to mitigate +# the impact of a breaking change or known issue. + +# areas: +# An optional array of strings that denotes the parts/components/services +# of the product that are affected. + +# description: +# An optional string that provides additional information. +# (Max 600 characters). + +# feature-id: +# An optional string to associate a feature or enhanceent with a +# unique feature flag. + +# highlight: +# An optional boolean for items that should be included in release +# highlights or the UI to draw user attention. + +# impact: +# An optional string that describes how the user's environment is +# affected by a breaking change or known issue. + +# issues: +# An optional array of strings that contain the issues that are +# relevant to the PR. + +# prs: +# An optional array of strings that contain the pull request numbers. + +# subtype: +# An optional string that applies only to breaking changes. +# It can be one of: +# - api +# - behavioral +# - configuration +# - dependency +# - subscription +# - plugin +# - security +# - other + +prs: +- "1017" +type: enhancement +products: +- product: edot-java + lifecycle: ga +title: Update stream OpenTelemetry agent dependencies to 2.26.1 +description: >- + * opentelemetry-javaagent: [2.26.1](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.26.1) + + * opentelemetry-sdk: [1.60.1](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.60.1) + + * opentelemetry-semconv: [1.40.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.40.0) + + * opentelemetry-java-contrib: [1.54.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.54.0) diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index e5895db9a..b97788767 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -28,6 +28,10 @@ Breaking changes can impact your applications, potentially disrupting normal ope % :::: % TEMPLATE END +:::{changelog} /releases/ +:type: breaking-change +::: + ::::{dropdown} OpenAI instrumentation switched from openai-client to openai In OpenTelemetry Java agent version 2.18.0, an `openai` instrumentation module was added. This conflicted with the `openai-client` instrumentation module that was implemented in the EDOT agent. Since the `openai` module is on by default, we switched off the `openai-client` instrumentation module (previously on by default). The functionality is broadly the same. **Impact**
Small changes in span names and attributes expected. If the elastic specific `ELASTIC_OTEL_JAVA_INSTRUMENTATION_GENAI_EMIT_EVENTS` was previously set to true, this would no longer produce events. diff --git a/docs/release-notes/deprecations.md b/docs/release-notes/deprecations.md index 308b35095..32647752f 100644 --- a/docs/release-notes/deprecations.md +++ b/docs/release-notes/deprecations.md @@ -30,4 +30,8 @@ Review the deprecated functionality for Elastic Distribution of OpenTelemetry Ja % :::: % TEMPLATE END -No deprecations. \ No newline at end of file +No deprecations. + +:::{changelog} /releases/ +:type: deprecation +::: \ No newline at end of file diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index c8843cc0f..d9afde299 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -27,6 +27,11 @@ To check for security updates, go to [Security announcements for the Elastic sta % ### Fixes [edot-java-X.X.X-fixes] % * +:::{changelog} /releases/ +::: + +TEST + ## 1.10.0 [edot-java-1-10-0-release-notes] **Release date:** March 24, 2026 diff --git a/docs/release-notes/known-issues.md b/docs/release-notes/known-issues.md index 8830d3c74..b9f21b36c 100644 --- a/docs/release-notes/known-issues.md +++ b/docs/release-notes/known-issues.md @@ -14,3 +14,8 @@ products: # Elastic Distribution of OpenTelemetry Java known issues No known issues. + + +:::{changelog} /releases/ +:type: known-issue +::: \ No newline at end of file diff --git a/docs/releases/1.10.0.yaml b/docs/releases/1.10.0.yaml index 91e67e4ca..e00a92386 100644 --- a/docs/releases/1.10.0.yaml +++ b/docs/releases/1.10.0.yaml @@ -1,19 +1,25 @@ -products: +products: - product: edot-java target: 1.10.0 - lifecycle: ga repo: elastic-otel-java owner: elastic +description: The 1.10.0 release contains fixes for potential security vulnerabilities. Refer to our [security advisory](https://discuss.elastic.co/t/elastic-otel-java-1-10-0-security-update-esa-2026-22-ghsa-xw7x-h9fj-p2c7/385700) for more details. entries: - file: - name: upstream-update.yaml - checksum: d71dbd28df5b9fad9ad8ab6a703070092ac76172 + name: 1017.yaml + checksum: 9e2bb4cf3e68d95fd160eb23b35c284036fb75b0 type: enhancement - title: Update upstream OpenTelemetry agent dependencies to 2.26.1 + title: Update stream OpenTelemetry agent dependencies to 2.26.1 products: - product: edot-java - target: 1.10.0 lifecycle: ga - description: '- javaagent:[2.26.1](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.26.1) sdk:[1.60.1](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.60.1) semconv:[1.40.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.40.0) contrib:[1.54.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.54.0)' + description: >- + * opentelemetry-javaagent: [2.26.1](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.26.1) + + * opentelemetry-sdk: [1.60.1](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.60.1) + + * opentelemetry-semconv: [1.40.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.40.0) + + * opentelemetry-java-contrib: [1.54.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.54.0) prs: - - https://github.com/elastic/elastic-otel-java/pull/1017 + - "1017" From 051c64d337b8997fb9aeb695c3bf2d8a64dc96b2 Mon Sep 17 00:00:00 2001 From: Sylvain Juge <763082+SylvainJuge@users.noreply.github.com> Date: Fri, 10 Apr 2026 09:43:15 +0200 Subject: [PATCH 2/2] add release dates to existing releases --- docs/releases/1.0.0.yaml | 1 + docs/releases/1.1.0.yaml | 1 + docs/releases/1.10.0.yaml | 1 + docs/releases/1.2.0.yaml | 1 + docs/releases/1.2.1.yaml | 1 + docs/releases/1.3.0.yaml | 1 + docs/releases/1.4.0.yaml | 1 + docs/releases/1.4.1.yaml | 1 + docs/releases/1.5.0.yaml | 1 + docs/releases/1.6.0.yaml | 1 + docs/releases/1.7.0.yaml | 1 + docs/releases/1.8.0.yaml | 1 + docs/releases/1.9.0.yaml | 1 + 13 files changed, 13 insertions(+) diff --git a/docs/releases/1.0.0.yaml b/docs/releases/1.0.0.yaml index 066fedc0d..d50b7ed6c 100644 --- a/docs/releases/1.0.0.yaml +++ b/docs/releases/1.0.0.yaml @@ -4,6 +4,7 @@ products: lifecycle: ga repo: elastic-otel-java owner: elastic +release-date: '2024-09-02' entries: - file: name: 1774534599-first-ga-release.yaml diff --git a/docs/releases/1.1.0.yaml b/docs/releases/1.1.0.yaml index ee8587949..bd4e209ba 100644 --- a/docs/releases/1.1.0.yaml +++ b/docs/releases/1.1.0.yaml @@ -4,6 +4,7 @@ products: lifecycle: ga repo: elastic-otel-java owner: elastic +release-date: '2024-11-21' entries: - file: name: 455.yaml diff --git a/docs/releases/1.10.0.yaml b/docs/releases/1.10.0.yaml index e00a92386..04c77727d 100644 --- a/docs/releases/1.10.0.yaml +++ b/docs/releases/1.10.0.yaml @@ -4,6 +4,7 @@ repo: elastic-otel-java owner: elastic description: The 1.10.0 release contains fixes for potential security vulnerabilities. Refer to our [security advisory](https://discuss.elastic.co/t/elastic-otel-java-1-10-0-security-update-esa-2026-22-ghsa-xw7x-h9fj-p2c7/385700) for more details. +release-date: '2026-03-24' entries: - file: name: 1017.yaml diff --git a/docs/releases/1.2.0.yaml b/docs/releases/1.2.0.yaml index 717c80fc5..3449a033c 100644 --- a/docs/releases/1.2.0.yaml +++ b/docs/releases/1.2.0.yaml @@ -4,6 +4,7 @@ products: lifecycle: ga repo: elastic-otel-java owner: elastic +release-date: '2025-01-20' entries: - file: name: 497.yaml diff --git a/docs/releases/1.2.1.yaml b/docs/releases/1.2.1.yaml index 3d4ce695e..3714f3f15 100644 --- a/docs/releases/1.2.1.yaml +++ b/docs/releases/1.2.1.yaml @@ -4,6 +4,7 @@ products: lifecycle: ga repo: elastic-otel-java owner: elastic +release-date: '2025-01-23' entries: - file: name: 514.yaml diff --git a/docs/releases/1.3.0.yaml b/docs/releases/1.3.0.yaml index 47b85bc21..c47c0bcae 100644 --- a/docs/releases/1.3.0.yaml +++ b/docs/releases/1.3.0.yaml @@ -4,6 +4,7 @@ products: lifecycle: ga repo: elastic-otel-java owner: elastic +release-date: '2025-03-10' entries: - file: name: 564.yaml diff --git a/docs/releases/1.4.0.yaml b/docs/releases/1.4.0.yaml index c14d0ed94..ec02e04e6 100644 --- a/docs/releases/1.4.0.yaml +++ b/docs/releases/1.4.0.yaml @@ -4,6 +4,7 @@ products: lifecycle: ga repo: elastic-otel-java owner: elastic +release-date: '2025-04-15' entries: - file: name: 583.yaml diff --git a/docs/releases/1.4.1.yaml b/docs/releases/1.4.1.yaml index d213eedc8..6e2708e35 100644 --- a/docs/releases/1.4.1.yaml +++ b/docs/releases/1.4.1.yaml @@ -4,6 +4,7 @@ products: lifecycle: ga repo: elastic-otel-java owner: elastic +release-date: '2025-04-16' entries: - file: name: 610.yaml diff --git a/docs/releases/1.5.0.yaml b/docs/releases/1.5.0.yaml index 0dff5b1ac..7e5acdfde 100644 --- a/docs/releases/1.5.0.yaml +++ b/docs/releases/1.5.0.yaml @@ -4,6 +4,7 @@ products: lifecycle: ga repo: elastic-otel-java owner: elastic +release-date: '2025-07-28' entries: - file: name: 1774965825-tech-preview-release-of-central-configuration-supp.yaml diff --git a/docs/releases/1.6.0.yaml b/docs/releases/1.6.0.yaml index ee45c0f0e..9ad8bf07c 100644 --- a/docs/releases/1.6.0.yaml +++ b/docs/releases/1.6.0.yaml @@ -4,6 +4,7 @@ products: lifecycle: ga repo: elastic-otel-java owner: elastic +release-date: '2025-10-06' entries: - file: name: 818.yaml diff --git a/docs/releases/1.7.0.yaml b/docs/releases/1.7.0.yaml index 3b6e7c123..44a61ba7a 100644 --- a/docs/releases/1.7.0.yaml +++ b/docs/releases/1.7.0.yaml @@ -4,6 +4,7 @@ products: lifecycle: ga repo: elastic-otel-java owner: elastic +release-date: '2025-11-05' entries: - file: name: 835.yaml diff --git a/docs/releases/1.8.0.yaml b/docs/releases/1.8.0.yaml index a877c9830..4cc4f6d72 100644 --- a/docs/releases/1.8.0.yaml +++ b/docs/releases/1.8.0.yaml @@ -4,6 +4,7 @@ products: lifecycle: ga repo: elastic-otel-java owner: elastic +release-date: '2025-12-09' entries: - file: name: 899.yaml diff --git a/docs/releases/1.9.0.yaml b/docs/releases/1.9.0.yaml index 980a7a0fb..434166813 100644 --- a/docs/releases/1.9.0.yaml +++ b/docs/releases/1.9.0.yaml @@ -4,6 +4,7 @@ products: lifecycle: ga repo: elastic-otel-java owner: elastic +release-date: '2026-02-09' entries: - file: name: 958.yaml