feat: Add iOS auto-update SDK #15711
Open
+105
−19
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
philipphofmann
approved these changes
Dec 3, 2025
Member
philipphofmann
left a comment
philipphofmann
left a comment
There was a problem hiding this comment.
LGTM, with two suggestions.
docs/platforms/apple/guides/ios/build-distribution/auto-update.mdx
Outdated
Show resolved
Hide resolved
philipphofmann
approved these changes
Dec 3, 2025
Member
philipphofmann
left a comment
philipphofmann
left a comment
There was a problem hiding this comment.
LGTM, one more suggestion.
Comment on lines
+47
to
+54
| 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
24
to
25
| <Include name="build-distribution/create-integration-token" /> | ||
| 8. Save the new token, you will need it when using the SDK from Swift. |
Member
There was a problem hiding this comment.
m: That's looks very fragile and easy to break when somebody changes the include. I think you should be able to use 1. 1. 1. for all bullet points and markdown will just add the correct numbers for you.
so basically do this in the include
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**
and then
Suggested change
| <Include name="build-distribution/create-integration-token" /> | |
| 8. Save the new token, you will need it when using the SDK from Swift. | |
| <Include name="build-distribution/create-integration-token" /> | |
| 1. Save the new token, you will need it when using the SDK from Swift. |
Contributor
Author
There was a problem hiding this comment.
Never knew that before, neat!
Contributor
Author
There was a problem hiding this comment.
So that didn't work, any idea if there is another way @philipphofmann ?
Member
There was a problem hiding this comment.
Nope, sorry, then maybe it doesn't work.
noahsmartin
force-pushed
the
iOSUpdateSDK
branch
from
873cecb to
64c987f
Compare
Bundle ReportChanges will increase total bundle size by 60.27kB (0.17%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
noahsmartin
force-pushed
the
iOSUpdateSDK
branch
from
d3e8e0c to
20d84a4
Compare
runningcode
approved these changes
Dec 5, 2025
| } | ||
| ``` | ||
|
|
||
| This expect to find the environment variable `SENTRY_DISTRIBUTION_AUTH_TOKEN`, copy the token you generated in the preceding step to this variable in your CI environment. |
Contributor
There was a problem hiding this comment.
Suggested change
| This expect to find the environment variable `SENTRY_DISTRIBUTION_AUTH_TOKEN`, copy the token you generated in the preceding step to this variable in your CI environment. | |
| This expects to find the environment variable `SENTRY_DISTRIBUTION_AUTH_TOKEN`, copy the token you generated in the preceding step to this variable in your CI environment. |
|  | ||
| 1. Click **Save Changes** | ||
| 1. Scroll down to the Tokens section and click **New Token** | ||
|  |
|
|
||
| ## 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.
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?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
DESCRIBE YOUR PR
Adding docs for the new update SDK released in iOS v9
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
EXTRA RESOURCES