-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
docs(apple): restructure install docs and add SentryObjC #17926
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
Draft
philprime
wants to merge
4
commits into
master
Choose a base branch
from
philprime/apple-install-restructure-sentryobjc
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
f3aba63
docs(apple): restructure install docs and add SentryObjC
philprime 965ece2
fix(apple): correct SentryObjC availability
philprime a04d117
docs(apple): deprecate SentrySwiftUI product
philprime b2f7350
Apply suggestion from @philprime
philprime File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,14 +7,21 @@ sidebar_order: 3000 | |
| To integrate Sentry into your Xcode project, follow these steps: | ||
|
|
||
| 1. Download the latest version of the SDK from the Sentry Cocoa [Releases page](https://github.com/getsentry/sentry-cocoa/releases). | ||
| 2. Each release contains the following four framework options: | ||
| - Sentry-Dynamic.xcframework.zip: Dynamic framework | ||
| - Sentry.xcframework.zip: Static framework | ||
| - SentrySwiftUI.xcframework.zip: Static Framework with SwiftUI support | ||
| - Sentry-WithoutUIKitOrAppKit.xcframework.zip: Static framework without UIKit or AppKit linking and related features | ||
| 2. Each release contains the following framework options: | ||
|
|
||
| **Sentry (Swift / standard Objective-C):** | ||
| - `Sentry.xcframework.zip` — Static framework (recommended) | ||
| - `Sentry-Dynamic.xcframework.zip` — Dynamic framework | ||
| - `SentrySwiftUI.xcframework.zip` — Deprecated. SwiftUI tracking is now included in the main `Sentry` framework. | ||
| - `Sentry-WithoutUIKitOrAppKit.xcframework.zip` — Static framework without UIKit or AppKit linking and related features | ||
|
|
||
| **SentryObjC (pure Objective-C interface):** | ||
| - `SentryObjC-Dynamic.xcframework.zip` — Dynamic framework | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| 3. Import the chosen framework into your Xcode project target. | ||
|
|
||
| ### Usage Guidelines: | ||
| ### Usage Guidelines | ||
|
|
||
| • Use `Sentry-Dynamic`, `Sentry`, or `Sentry-WithoutUIKitOrAppKit` independently. Only one of these should be included in your project at a time. | ||
| • If you're using `SentrySwiftUI`, it must be combined with `Sentry-Dynamic`. | ||
| - Use `Sentry-Dynamic`, `Sentry`, or `Sentry-WithoutUIKitOrAppKit` independently. Only one of these should be included in your project at a time. | ||
| - `SentrySwiftUI` is deprecated. If you still use it, it must be combined with `Sentry-Dynamic`. | ||
| - Use **SentryObjC** when you need a pure Objective-C interface — no Swift headers, no `@import`, no `-Swift.h`. This is recommended for Objective-C++ projects or projects with Clang modules disabled. Each SentryObjC framework embeds the full Sentry SDK, so do not link both `Sentry` and `SentryObjC` in the same target. See <PlatformLink to="/install/swift-package-manager/#sentryobjc">SentryObjC</PlatformLink> for configuration details. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
l: Adding the name for @import, wdyt?