Skip to content
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.

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

Add details on differences between auto vs manual setup of Cocoa SDK #87181

Open
philprime opened this issue Mar 17, 2025 · 0 comments
Open

Add details on differences between auto vs manual setup of Cocoa SDK #87181

philprime opened this issue Mar 17, 2025 · 0 comments

Comments

@philprime
Copy link

When configuring an iOS SDK, there are two options: Auto and Manual.

If choosing Auto, it summarizes the steps take like this:

The Sentry wizard will automatically patch your application:

  • Install the Sentry SDK via Swift Package Manager or Cocoapods
  • Update your AppDelegate or SwiftUI App Initializer with the default Sentry configuration and an example error
  • Add a new Upload Debug Symbols phase to your xcodebuild build script
  • Create .sentryclirc with an auth token to upload debug symbols (this file is automatically added to .gitignore)
  • When you're using Fastlane, it will add a Sentry lane for uploading debug symbols

For the Manual setup we only mention the setup of the SDK and the verification example error.

I would like to discuss two points:

  1. We should add a warning at the top indicating that the manual process does not cover all the steps taken by the wizard.
  2. We should give the setup step for the uploading of debug symbols a more prominent location, i.e. before Configure SDK there should be a section "Setup Uploading Debug Symbols" which gives a summary of the purpose and benefits, with link to the user docs with relevant setup steps. This would keep the guide slim, while not making users skip the step all together.

cc @jas-kas @kahest

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Needs Discussion
Development

No branches or pull requests

1 participant