-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat: Add iOS auto-update SDK #15711
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| --- | ||
| title: Auto-Update SDK | ||
| sidebar_title: Auto-Update SDK | ||
| sidebar_order: 10 | ||
| description: Enable automatic update checks and installations for internal iOS builds using the Sentry Auto-Update SDK. | ||
| --- | ||
|
|
||
| <Include name="feature-available-for-user-group-early-adopter" /> | ||
|
|
||
| <Alert level="warning"> | ||
|
|
||
| The Auto-Update SDK is designed for **internal builds only** and should never be used in production builds distributed through the App Store. | ||
|
|
||
| </Alert> | ||
|
|
||
| The Sentry Auto-Update SDK enables your internal iOS builds to automatically check for and install newer versions distributed through Sentry's Build Distribution. This is particularly useful for distributing nightly, alpha, or beta builds to your internal teams. It is not required to use the Sentry crash reporting SDK to use the iOS Auto-Update SDK. | ||
|
|
||
| ## Pre-requisites | ||
|
|
||
| The SDK can only be installed using Swift Package Manager. | ||
|
|
||
| You'll also need an [internal integration token](#create-an-integration-token) with Build Distribution permissions. | ||
|
|
||
| <Include name="build-distribution/create-integration-token" /> | ||
|
|
||
| ## Installation | ||
|
|
||
| Add a dependency on the `SentryDistribution` target contained in the sentry-cocoa package (https://github.com/getsentry/sentry-cocoa) | ||
|
|
||
| ```swift {filename:Package.swift} | ||
| .package(url: "https://github.com/getsentry/sentry-cocoa", from: "{{@inject packages.version('sentry.cocoa') }}"), | ||
|
|
||
| .target(name: "MyTarget", dependencies: ["SentryDistribution"]), | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Use the SDK by calling `Updater.checkForUpdate(params: )`. In addition to the access token, provide your Sentry org and project slug in the CheckForUpdateParams. For example: | ||
|
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. I'm not very familiar with xcode but is there a way to provide a script to xcode that would create a file in the app that would automatically pass these things in? |
||
|
|
||
| ```swift {filename:MyView.swift} | ||
| import SentryDistribution | ||
| import SwiftUI | ||
|
|
||
| struct MyView: View { | ||
| var body: some View { | ||
| Button("Check For Update") { | ||
| let params = CheckForUpdateParams( | ||
| accessToken: "MY_TOKEN", | ||
| organization: "___ORG_SLUG___", | ||
| project: "___PROJECT_SLUG___") | ||
| Updater.checkForUpdate(params: params) { result in | ||
| handleUpdateResult(result: result) | ||
| } | ||
|
Comment on lines
+46
to
+53
Member
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. Way better thanks |
||
| } | ||
noahsmartin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| static func handleUpdateResult(result: Result<UpdateCheckResponse, Error>) { | ||
| guard case let .success(releaseInfo) = result else { | ||
| // Handle error | ||
| return | ||
| } | ||
|
|
||
| guard let releaseInfo = releaseInfo.update else { | ||
| print("Already up to date") | ||
| return | ||
| } | ||
|
|
||
| guard let url = Updater.buildUrlForInstall(releaseInfo.downloadUrl) else { | ||
| return | ||
| } | ||
| DispatchQueue.main.async { | ||
| Updater.install(url: url) | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Security Considerations | ||
|
|
||
| - **Internal Use Only**: Never ship the auto-update SDK in production builds destined for public app stores | ||
| - **Token Security**: The distribution token is embedded in the app and can be extracted by reverse engineering. Use tokens with only the distribution read permission which is the minimum required permission for the auto-update SDK. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| ## Create an Integration Token | ||
|
|
||
| To use the Auto-Update SDK, you need to create an internal integration token with the appropriate permissions: | ||
|
|
||
| 1. Navigate to **Settings > Custom Integrations** in your Sentry organization | ||
| 1. Click **Create New Integration** | ||
|  | ||
|
|
||
| 1. Select **Internal Integration** and click **Next** | ||
|  | ||
|
|
||
| 1. Give your integration a name (e.g., "Build Distribution") | ||
|  | ||
| 1. Under **Permissions**, select **Read** next to the **Distribution** scope. | ||
|  | ||
| 1. Click **Save Changes** | ||
| 1. Scroll down to the Tokens section and click **New Token** | ||
|  | ||
|
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. nit: indentation |
||
| 1. Save the generated token, you'll need it to integrate the SDK | ||
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.