-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(apple): Migration Guide for V9 #15649
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?
Conversation
Add the migration guide for major version v9.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
||
| - We made the following classes `final`: `PreviewRedactOptions`, `SentryProfileOptions`, `SentryRedactViewHelper`, `SentryViewScreenshotOptions`, `SentryReplayOptions`, `SentryUserFeedbackConfiguration`, `SentryUserFeedbackFormConfiguration`, `SentryUserFeedbackThemeConfiguration`, `SentryUserFeedbackWidgetConfiguration`, `SentryFeedback`, and `SentryExperimentalOptions` | ||
|
|
||
| For a complete list of changes, see the [Changelog of version 9.0.0](https://github.com/getsentry/sentry-cocoa/releases/tag/9.0.0) |
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.
This link will exist when we publish the release
philprime
left a comment
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.
Thank you for preparing this, I found a couple of improvement opportunities we should adapt in this PR or in a follow-up.
I used this prompt to cross-check with the CHANGELOG in sentry-cocoa:
Use `gh` to view the PR description and changes of the current branch's PR. We want to have a migration guide for the sentry-cocoa v9 release. You can find the changelog for v9 at /path/to/sentry-cocoa/CHANGELOG.md
Analyze the proposed changes and give me a list of changes. A good list entry looks like this:
---
Developers upgrading to v9.0.0 will encounter contradictory documentation regarding `enablePerformanceV2`. The new migration guide explicitly states that `enablePerformanceV2` was removed, but the `automatic-instrumentation.mdx` file, which was not updated in this pull request, still contains instructions and code examples for enabling this option. This inconsistency will lead developers to attempt to configure a non-existent option, causing confusion and potential build or runtime errors.
**Suggested Fix:**
Update `docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx` to remove all references to `enablePerformanceV2` and clarify that Performance V2 is now enabled by default.
---
IMPORTANT: Keep in mind that the docs are used by developers/humans and should be concise and easy to understand. For each option and API we offer, check the documentation to find inconsistencies
Bundle ReportChanges will increase total bundle size by 57.51kB (0.16%) ⬆️. 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:
|
## DESCRIBE YOUR PR Adds docs for the new UI Profiling APIs in the browser. part of getsentry/sentry-javascript#17279 ## 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 --> - [ ] 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:* - [ ] Checked Vercel preview for correctness, including links - [ ] 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)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR This PR introduces the "Metrics" docs section for React Native docs. Comes in combination with this PR that introduces Metrics to RN: getsentry/sentry-react-native#5402 ## 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 - [ ] 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) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms. ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
Co-authored-by: Philip Niedertscheider <phil.niedertscheider@sentry.io>
|
I asked Claude to validate the code snippets in this branch for me. According to Claude they are valid ✅ Claude Report
Code Snippets Validation Report for PR #15649Sentry-Cocoa v9.0.0 Migration GuideThis report validates all code snippets in the migration guide against the sentry-cocoa main branch (v9.0.0). ✅ VALIDATED APIs1. Profiling API:
|
|
I also used Claude to add the modified code snippets to our sample apps to validate that they're compiling Claude Test Run
Snippet Compilation Report for Sentry Cocoa v9 Migration Guide
Updated Files in the Cocoa Repo
Each block configures Snippets Verified (Swift)All located inside
Snippets Verified (Objective-C)All located inside
Known Doc DiscrepancyThe documentation snippet for Objective-C FileManager swizzling uses How to Repeat This Verification
This workflow makes it straightforward to refresh the helpers whenever the migration guide changes, ensuring the published examples continue to compile. |
DESCRIBE YOUR PR
Add the migration guide for major version v9. We still have to wait for Cocoa V9 to be shipped on Monday Dec 1st to merge this PR.
We also need to double check if we merged getsentry/sentry-cocoa#6327 before the release, if yes, we must include it in here.
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: