Skip to content

Commit 8bae197

Browse files
logaretmcodex
andcommitted
docs: note internal package status
Co-Authored-By: OpenAI Codex <codex@openai.com>
1 parent 0d61af3 commit 8bae197

8 files changed

Lines changed: 53 additions & 6 deletions

File tree

‎packages/browser-utils/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,7 @@
1818

1919
Common utilities used by the Sentry JavaScript SDKs.
2020

21-
Note: This package is only meant to be used internally, and as such is not part of our public API contract and does not
22-
follow semver.
21+
## Package Status
22+
23+
This package is an internal library published for use by Sentry-owned JavaScript SDK packages. It is not part of the
24+
public API contract and may change in any release. Do not rely on SemVer compatibility if you depend on it directly.

‎packages/eslint-config-sdk/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@
1818

1919
Install with `yarn add -D @sentry/eslint-config-sdk`
2020

21+
## Package Status
22+
23+
This package is an internal library published for use by Sentry-owned JavaScript SDK packages and repositories. It is not
24+
part of the public API contract and may change in any release. Do not rely on SemVer compatibility if you depend on it
25+
directly.
26+
2127
## Configuration
2228

2329
Use `@sentry-internal` for base rules. Make sure to specify your tsconfig under `parserOptions.project` so that you can
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<p align="center">
2+
<a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
3+
<img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
4+
</a>
5+
</p>
6+
7+
# Official Sentry SDK ESLint Plugin
8+
9+
[![npm version](https://img.shields.io/npm/v/@sentry/eslint-plugin-sdk.svg)](https://www.npmjs.com/package/@sentry/eslint-plugin-sdk)
10+
[![npm dm](https://img.shields.io/npm/dm/@sentry/eslint-plugin-sdk.svg)](https://www.npmjs.com/package/@sentry/eslint-plugin-sdk)
11+
[![npm dt](https://img.shields.io/npm/dt/@sentry/eslint-plugin-sdk.svg)](https://www.npmjs.com/package/@sentry/eslint-plugin-sdk)
12+
13+
## Package Status
14+
15+
This package is an internal library published for use by Sentry-owned JavaScript SDK packages and repositories. It is not
16+
part of the public API contract and may change in any release. Do not rely on SemVer compatibility if you depend on it
17+
directly.

‎packages/feedback/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
# Sentry Integration for Feedback
88

9+
## Package Status
10+
11+
This package is an internal library published for use by Sentry-owned JavaScript SDK packages. It is not part of the
12+
public API contract and may change in any release. Do not rely on SemVer compatibility if you depend on it directly.
13+
914
This SDK is **considered experimental and in a beta state**. It may experience breaking changes, and may be discontinued
1015
at any time. Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have
1116
any feedback/concerns.

‎packages/replay-canvas/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66

77
# Sentry Session Replay with Canvas
88

9+
## Package Status
10+
11+
This package is an internal library published for use by Sentry-owned JavaScript SDK packages. It is re-exported from
12+
`@sentry/browser` and other browser-related SDKs like `@sentry/react` and `@sentry/vue`. It is not part of the public API
13+
contract and may change in any release. Do not rely on SemVer compatibility if you depend on it directly.
14+
915
## Pre-requisites
1016

1117
Replay with canvas requires Node 14+, and browsers newer than IE11.

‎packages/replay-internal/README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,11 @@
1010
[![npm dm](https://img.shields.io/npm/dm/@sentry/replay.svg)](https://www.npmjs.com/package/@sentry/replay)
1111
[![npm dt](https://img.shields.io/npm/dt/@sentry/replay.svg)](https://www.npmjs.com/package/@sentry/replay)
1212

13-
This is an internal package that is being re-exported in `@sentry/browser` and other browser-related SDKs like
14-
`@sentry/react` or `@sentry/vue`.
13+
## Package Status
14+
15+
This package is an internal library published for use by Sentry-owned JavaScript SDK packages. It is re-exported from
16+
`@sentry/browser` and other browser-related SDKs like `@sentry/react` and `@sentry/vue`. It is not part of the public API
17+
contract and may change in any release. Do not rely on SemVer compatibility if you depend on it directly.
1518

1619
## Pre-requisites
1720

‎packages/server-utils/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,7 @@
1919
Common server-only utilities used by the Sentry JavaScript server SDKs (node, node-core, bun, deno, cloudflare,
2020
aws-serverless, google-cloud-serverless, vercel-edge).
2121

22-
Note: This package is only meant to be used internally, and as such is not part of our public API contract and does not
23-
follow semver.
22+
## Package Status
23+
24+
This package is an internal library published for use by Sentry-owned JavaScript SDK packages. It is not part of the
25+
public API contract and may change in any release. Do not rely on SemVer compatibility if you depend on it directly.

‎packages/typescript/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@
1818

1919
Shared typescript configuration used at Sentry.
2020

21+
## Package Status
22+
23+
This package is an internal library published for use by Sentry-owned JavaScript SDK packages and repositories. It is not
24+
part of the public API contract and may change in any release. Do not rely on SemVer compatibility if you depend on it
25+
directly.
26+
2127
## Installation
2228

2329
```sh

0 commit comments

Comments
 (0)