Skip to content

Commit fc78960

Browse files
authored
Update cocoa SDK setup instructions (#15587)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR The motivation behind this PR is to change "This is important" to "This is *required*" in the cocoapods instructions. However I also noticed that we recommended using cocoapods, even though cocoapods as a whole is in maintenance mode and not recommended for iOS apps so I updated it to recommend SPM. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [X] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [x] Checked Vercel preview for correctness, including links - [x] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs)
1 parent 88b9913 commit fc78960

File tree

4 files changed

+6
-17
lines changed

4 files changed

+6
-17
lines changed

docs/platforms/apple/common/install/cocoapods.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To integrate Sentry into your Xcode project using CocoaPods, specify it in your
88

99
```ruby
1010
platform :ios, '11.0'
11-
use_frameworks! # This is important
11+
use_frameworks! # This is required
1212

1313
target 'YourApp' do
1414
pod 'Sentry', :git => 'https://github.com/getsentry/sentry-cocoa.git', :tag => '{{@inject packages.version('sentry.cocoa') }}'

docs/platforms/apple/common/install/swift-package-manager.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,3 @@ Alternatively, when your project uses a `Package.swift` file to manage dependenc
2727
```swift {tabTitle:Swift}
2828
.package(url: "https://github.com/getsentry/sentry-cocoa", from: "{{@inject packages.version('sentry.cocoa') }}"),
2929
```
30-
31-
<Alert>
32-
33-
Version tags or branches need to have the Package.swift file in it or Xcode won't be able to install the package. This means versions previous to `4.4.3` _cannot_ be installed using SPM.
34-
35-
</Alert>

docs/platforms/apple/common/tracing/instrumentation/swiftui-instrumentation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You can monitor the performance of your views in a SwiftUI project with the Sent
1414

1515
```ruby
1616
platform :ios, '13.0'
17-
use_frameworks! # This is important
17+
use_frameworks! # This is required
1818

1919
target 'YourApp' do
2020
pod 'SentrySwiftUI', :git => 'https://github.com/getsentry/sentry-cocoa.git', :tag => '{{@inject packages.version('sentry.cocoa') }}'

docs/platforms/apple/guides/ios/manual-setup.mdx

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,13 @@ If you can't (or prefer not to) run the [automatic setup](/platforms/apple/guide
1010

1111
The minimum required version for iOS is 11.0.
1212

13-
We recommend installing the SDK with CocoaPods, but we also support alternate [installation methods](/platforms/apple/guides/ios/install/). To integrate Sentry into your Xcode project, specify it in your `Podfile`:
13+
We recommend installing the SDK with SPM, but we also support alternate [installation methods](/platforms/apple/guides/ios/install/). To integrate Sentry into your Xcode project, add the package using the Github URL:
1414

15-
```ruby {filename:Podfile}
16-
platform :ios, '11.0'
17-
use_frameworks! # This is important
18-
19-
target 'YourApp' do
20-
pod 'Sentry', :git => 'https://github.com/getsentry/sentry-cocoa.git', :tag => '{{@inject packages.version('sentry.cocoa') }}'
21-
end
15+
```
16+
https://github.com/getsentry/sentry-cocoa.git
2217
```
2318

24-
Then run `pod install`.
19+
The Package has a few products you can depend on, but the recommended one is `Sentry`. For more details see the full docs on using [Swift Package Manager](/platforms/apple/guides/ios/install/swift-package-manager).
2520

2621
## Configuration
2722

0 commit comments

Comments
 (0)