Skip to content

Conversation

@philipphofmann
Copy link
Member

Add known issue to 8.53.0 and recommend updating to 8.53.1.

#skip-changelog

Add known issue to 8.53.0 and recommend updating to 8.53.1.
@philipphofmann
Copy link
Member Author

@sentry review

@seer-by-sentry
Copy link

On it! We are reviewing the PR and will provide feedback shortly.

@seer-by-sentry
Copy link

PR Description

This pull request updates the CHANGELOG.md file to include a warning for version 8.53.0 of the Sentry Cocoa SDK. The warning informs users about a potential build error that can occur when using XCFrameworks due to a CFBundleVersion string length limitation.

Click to see more

Key Technical Changes

The primary technical change is the addition of a warning block in the CHANGELOG.md file. This block uses the [!Warning] syntax to highlight the issue and provides a specific error message example related to the CFBundleVersion key in the Info.plist file. It also directs users to update to version 8.53.1 to resolve the problem.

Architecture Decisions

No architectural decisions are involved as this change only affects documentation.

Dependencies and Interactions

This change does not introduce any new dependencies or interact with other parts of the system beyond updating the CHANGELOG.md file. It indirectly relates to the build process and XCFramework usage within projects using the Sentry Cocoa SDK.

Risk Considerations

The main risk is that users might miss the warning in the CHANGELOG.md file. To mitigate this, the warning should be prominently placed and clearly worded. There is also a risk that the provided error message might not exactly match what all users encounter, although it serves as a representative example.

Notable Implementation Details

The use of the [!Warning] block is a notable detail, as it's a specific convention for highlighting important information in markdown files. The inclusion of the specific error message and the recommended update version are also important for clarity and actionability.

@kahest kahest merged commit fdea6f5 into main Jun 26, 2025
10 checks passed
@kahest kahest deleted the philipphofmann-patch-1 branch June 26, 2025 13:20
philipsawyerdd added a commit to justin-doordash/sentry-cocoa that referenced this pull request Sep 25, 2025
philipsawyerdd added a commit to justin-doordash/sentry-cocoa that referenced this pull request Sep 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants