Use the wizard endpoint as an onboarding tool for SDKs

[bruno-garcia]

Installing Sentry is often as simple as adding a package and copy pasting a code snippet from Sentry.
In that code snippet, we already include the DSN for the project, so it's ready to go.

That's not exactly the case when the platform requires uploading something to Sentry. For example, native debug symbols, source maps or proguard mapping files. In these cases, besides the DSN, we need 3 things:

1. Auth token
2. org slug
3. project slug

Those need to be given not to the SDK, but to some part of the build pipeline of the app. And the values are not to be made public (auth token in particular), differently than DSN which is public.

Sentry Wizard - https://github.com/getsentry/sentry-wizard

A project in Sentry was built to automate this set up, for React Native. It relies on an endpoint on the server:

Server support was added in this PR:

• Setup Wizard sentry#6523

In product, onboarding wizard

The above is not to be configured with the "onboarding wizard in-product, which is maintained in the docs repo and pulled by Sentry when a new builds goes out.

Examples

This was done recently in the Unity SDK: getsentry/sentry-unity#780

The Sentry Wizard repo has a gif in the landing page showing how it works:

[bruno-garcia]

Another place to add the workflow is the Unreal package: https://github.com/getsentry/sentry-unreal

[mattjohnsonpint]

Note how the NextJS SDK team has done this https://docs.sentry.io/platforms/javascript/guides/nextjs/#install

[kahest]

closing - this has been superseded by more recent/current initiatives, see (among others)

• iOS cli-wizard sentry-wizard#330
• Feat(apple): Add cocoapods support sentry-wizard#350
• Feat(apple): Add Fastlane detector for iOS wizard sentry-wizard#356
• iOS Wizard Telemetry sentry-wizard#343
• Android cli-wizard sentry-wizard#316
• react-native adds wrap during setup sentry-wizard#280
• react-native wizard for Expo projects sentry-wizard#285
• react-native Add SAGP to the Android application sentry-wizard#287