Skip to content

chore(sveltekit): Update adapter compatibility in Readme #8272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 2, 2023
Merged

chore(sveltekit): Update adapter compatibility in Readme #8272

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac833a0
chore(sveltekit): Update adapter compatibility
Lms24 Jun 1, 2023
226efb1
Update packages/sveltekit/README.md
Lms24 Jun 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions packages/sveltekit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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.