From ac833a0a79ee37927fe621e2ac4d02b74f9aa4b9 Mon Sep 17 00:00:00 2001 From: Lukas Stracke Date: Thu, 1 Jun 2023 14:41:36 +0200 Subject: [PATCH 1/2] chore(sveltekit): Update adapter compatibility --- packages/sveltekit/README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/packages/sveltekit/README.md b/packages/sveltekit/README.md index 309b59fcd2ac..e8776c57c3fb 100644 --- a/packages/sveltekit/README.md +++ b/packages/sveltekit/README.md @@ -16,10 +16,18 @@ ## Compatibility -Currently, the minimum supported version of SvelteKit is `1.0.0`. +The minimum supported version of SvelteKit is `1.0.0`. The SDK works best with Vite 4.2 and newer. Older Vite versions might not generate source maps correctly. +The SDK supports the following SvelteKit adapters: +- `@sveltejs/adapter-auto` - for Vercel with the Node runtime. Other deployment targets might work but we don't guarantee compatibility. +- `@sveltejs/adapter-vercel` - only for Node (Lambda) runtimes, not yet Vercel's edge runtime +- `@sveltejs/adapter-node` + +If you use the SDK with other adapters, we cannot guarantee that everything works as expected. +You might need to [manually configure source maps upload](#-configuring-source-maps-upload). +The SDK is currently not compatible with none-Node server runtimes, such as Vercel's Edge runtime or Cloudflare workers. ## General This package is a wrapper around `@sentry/node` for the server and `@sentry/svelte` for the client side, with added functionality related to SvelteKit. @@ -40,9 +48,7 @@ If the setup through the wizard doesn't work for you, you can also set up the SD ### 1. Prerequesits & Installation -1. Ensure you've set up the [`@sveltejs/adapter-node` adapter](https://kit.svelte.dev/docs/adapter-node) - -2. Install the Sentry SvelteKit SDK: +1. Install the Sentry SvelteKit SDK: ```bash # Using npm @@ -310,12 +316,3 @@ export const load = wrapServerLoadWithSentry((event) => { }); ``` - -## Known Limitations - -This SDK is still under active development. -Take a look at our [SvelteKit SDK Development Roadmap](https://github.com/getsentry/sentry-javascript/issues/6692) to follow the progress. - -- **Adapters** other than `@sveltejs/adapter-node` are currently not supported. - We haven't yet tested other platforms like Vercel. - This is on our roadmap but it will come at a later time. From 226efb1173eae2e73bc050a08c1bee441e7282f1 Mon Sep 17 00:00:00 2001 From: Lukas Stracke Date: Fri, 2 Jun 2023 13:41:07 +0200 Subject: [PATCH 2/2] Update packages/sveltekit/README.md Co-authored-by: Francesco Novy --- packages/sveltekit/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/sveltekit/README.md b/packages/sveltekit/README.md index e8776c57c3fb..5ca2cff3e73d 100644 --- a/packages/sveltekit/README.md +++ b/packages/sveltekit/README.md @@ -28,6 +28,7 @@ The SDK supports the following SvelteKit adapters: If you use the SDK with other adapters, we cannot guarantee that everything works as expected. You might need to [manually configure source maps upload](#-configuring-source-maps-upload). The SDK is currently not compatible with none-Node server runtimes, such as Vercel's Edge runtime or Cloudflare workers. + ## General This package is a wrapper around `@sentry/node` for the server and `@sentry/svelte` for the client side, with added functionality related to SvelteKit.