Skip to content

Commit f1a95e9

Browse files
committed
chore: adjust changesets and readme
1 parent a6e5519 commit f1a95e9

File tree

3 files changed

+10
-7
lines changed

3 files changed

+10
-7
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@adobe/aio-lib-telemetry": patch
3+
---
4+
5+
Add [versioning policy](https://github.com/adobe/aio-lib-telemetry/blob/main/README.md#versioning-policy) to the README.

.changeset/updated-otel-deps.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,4 @@
22
"@adobe/aio-lib-telemetry": patch
33
---
44

5-
[[BREAKING]](https://github.com/adobe/aio-lib-telemetry/blob/main/README.md#versioning-policy) Update OpenTelemetry dependencies (see the [Renovate PR](https://github.com/adobe/aio-lib-telemetry/pull/62) for the full list).
6-
7-
Add [versioning policy](https://github.com/adobe/aio-lib-telemetry/blob/main/README.md#versioning-policy) to the README.
5+
[[BREAKING]](https://github.com/adobe/aio-lib-telemetry/blob/main/README.md#versioning-policy) Update OpenTelemetry dependencies (see the [Renovate PR](https://github.com/adobe/aio-lib-telemetry/pull/62) for the full list). The `otel` entrypoint no longer re-exports the `NoopLogRecordProcessor` class, as it's no longer exported by the OpenTelemetry Logs SDK. If you were using it, removing it should be safe, as it basically does nothing and it's the same as not using the processor at all.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ npm install @adobe/aio-lib-telemetry
1818

1919
## Versioning Policy
2020

21-
This library follows [semantic versioning](https://semver.org/) with one important exception: **breaking changes to the `otel` endpoint do not trigger major version releases**.
21+
This library follows [semantic versioning](https://semver.org/) with one important exception: **breaking changes to the `otel` entrypoint do not trigger major version releases**.
2222

23-
The [`otel` endpoint](./docs/api-reference/README.md#opentelemetry-api) re-exports OpenTelemetry APIs, which remain experimental and receive frequent updates that may include breaking changes. Strictly adhering to semantic versioning would require releasing a new major version with each OpenTelemetry update, which would be disruptive given their rapid release cadence.
23+
The [`otel` entrypoint](./docs/api-reference/README.md#opentelemetry-api) re-exports OpenTelemetry APIs, which remain experimental and receive frequent updates that may include breaking changes. Strictly adhering to semantic versioning would require releasing a new major version with each OpenTelemetry update, which would be disruptive given their rapid release cadence.
2424

2525
**Our versioning approach:**
2626

2727
- **Major versions** are reserved for breaking changes to our library's own API
28-
- **Minor/patch versions** may include breaking changes to the `otel` endpoint
28+
- **Minor/patch versions** may include breaking changes to the `otel` entrypoint
2929
- All breaking changes, including those in `otel`, are documented in release notes with a `[BREAKING]` label
3030

31-
**Recommendation:** Always review release notes before upgrading, especially if you use the `otel` endpoint directly.
31+
**Recommendation:** Always review release notes before upgrading, especially if you use the `otel` entrypoint directly.
3232

3333
## Usage
3434

0 commit comments

Comments
 (0)