Skip to content

Commit d86ab94

Browse files
committed
update migration docs
1 parent ccee1e2 commit d86ab94

File tree

5 files changed

+16
-9
lines changed

5 files changed

+16
-9
lines changed

MIGRATION.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -576,6 +576,8 @@ Removed top-level exports: `Offline`, `makeXHRTransport`, `BrowserTracing`, `wra
576576
- [Removal of Offline integration](./MIGRATION.md#removal-of-the-offline-integration)
577577
- [Removal of `makeXHRTransport` transport](./MIGRATION.md#removal-of-makexhrtransport-transport)
578578
- [Removal of `wrap` method](./MIGRATION.md#removal-of-wrap-method)
579+
- [Removal of `@sentry/angular-ivy` package](./MIGRATION.md#removal-of-sentryangular-ivy-package)
580+
- [Deprecation of `@sentry/replay` package](./MIGRATION.md#deprecation-of-sentryreplay-package)
579581

580582
#### Removal of the `BrowserTracing` integration
581583

@@ -604,6 +606,11 @@ requires at least Angular 14. If you are using Angular 13 or lower, we suggest u
604606
migrating to v8. If you can't upgrade your Angular version to at least Angular 14, you can also continue using the
605607
`@sentry/angular-ivy@7` SDK. However, v7 of the SDKs will no longer be fully supported going forward.
606608

609+
#### Deprecation of `@sentry/replay` package
610+
611+
You can import from `@sentry/browser` (or from a respective SDK package like `@sentry/react` or `@sentry/vue`) or
612+
`@sentry-internal/replay`.
613+
607614
### Server-side SDKs (Node, Deno, Bun, etc.)
608615

609616
Removed top-level exports: `enableAnrDetection`, `Anr`, `deepReadDirSync`
@@ -895,6 +902,8 @@ replacement API.
895902
- [Updated behaviour of `transactionContext` passed to `tracesSampler`](./MIGRATION.md#transactioncontext-no-longer-passed-to-tracessampler)
896903
- [Updated behaviour of `getClient()`](./MIGRATION.md#getclient-always-returns-a-client)
897904
- [Removal of Client-Side health check transaction filters](./MIGRATION.md#removal-of-client-side-health-check-transaction-filters)
905+
- [Change of Replay default options (`unblock` and `unmask`)](./MIGRATION.md#change-of-replay-default-options-unblock-and-unmask)
906+
- [Angular Tracing Decorator renaming](./MIGRATION.md#angular-tracing-decorator-renaming)
898907

899908
#### Updated behaviour of `tracePropagationTargets` in the browser (HTTP tracing headers & CORS)
900909

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ Besides the high-level SDKs, this repository contains shared packages, helpers a
9393
development. If you're thinking about contributing to or creating a JavaScript-based SDK, have a look at the resources
9494
below:
9595

96-
- [`@sentry/replay`](https://github.com/getsentry/sentry-javascript/tree/master/packages/replay): Provides the
97-
integration for Session Replay.
96+
- [`@sentry-internal/replay`](https://github.com/getsentry/sentry-javascript/tree/master/packages/replay-internal):
97+
Provides the integration for Session Replay.
9898
- [`@sentry/core`](https://github.com/getsentry/sentry-javascript/tree/master/packages/core): The base for all
9999
JavaScript SDKs with interfaces, type definitions and base classes.
100100
- [`@sentry/utils`](https://github.com/getsentry/sentry-javascript/tree/master/packages/utils): A set of helpers and

packages/replay-internal/README.md

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

77
# Sentry Session Replay
88

9-
[![npm version](https://img.shields.io/npm/v/@sentry/replay.svg)](https://www.npmjs.com/package/@sentry/replay)
10-
[![npm dm](https://img.shields.io/npm/dm/@sentry/replay.svg)](https://www.npmjs.com/package/@sentry/replay)
11-
[![npm dt](https://img.shields.io/npm/dt/@sentry/replay.svg)](https://www.npmjs.com/package/@sentry/replay)
9+
[![npm version](https://img.shields.io/npm/v/@sentry-internal/replay.svg)](https://www.npmjs.com/package/@sentry-internal/replay)
10+
[![npm dm](https://img.shields.io/npm/dm/@sentry-internal/replay.svg)](https://www.npmjs.com/package/@sentry-internal/replay)
11+
[![npm dt](https://img.shields.io/npm/dt/@sentry-internal/replay.svg)](https://www.npmjs.com/package/@sentry-internal/replay)
1212

1313
## Pre-requisites
1414

packages/replay-worker/README.md

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

77
# Sentry Session Replay Worker
88

9-
This is an internal package that is used by @sentry-internal/replay. It generates a web worker and converts it to a string, so
10-
that we can process it easier in replay.
9+
This is an internal package that is used by @sentry-internal/replay. It generates a web worker and converts it to a
10+
string, so that we can process it easier in replay.
1111

1212
By extracting this into a dedicated (private, internal) package, we can streamline the build of replay.
1313

packages/replay/package.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,6 @@
5050
"clean": "rimraf build sentry-replay-*.tgz",
5151
"fix": "eslint . --format stylish --fix",
5252
"lint": "eslint . --format stylish",
53-
"test": "jest",
54-
"test:watch": "jest --watch",
5553
"yalc:publish": "ts-node ../../scripts/prepack.ts --bundles && yalc publish ./build/npm --push --sig"
5654
},
5755
"repository": {

0 commit comments

Comments
 (0)