Skip to content

Commit 4e43ba9

Browse files
authored
docs: apply formatting to markdown files (#4837)
1 parent 8551aa5 commit 4e43ba9

8 files changed

Lines changed: 145 additions & 151 deletions

File tree

CHANGELOG.md

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
- Fix missing `sample_rate` in baggage (#4751)
2222
- Serializing SentryGeo with `nil` values (#4724)
2323

24-
### Internal
24+
### Internal
2525

2626
- Deserializing SentryEvents with Decodable (#4724)
2727
- Remove internal unknown dict for Breadcrumbs (#4803) This potentially only impacts hybrid SDKs.
@@ -160,7 +160,7 @@
160160
### Fixes
161161

162162
- Session replay touch tracking race condition (#4548)
163-
- Use `options.reportAccessibilityIdentifier` for Breadcrumbs and UIEvents (#4569)
163+
- Use `options.reportAccessibilityIdentifier` for Breadcrumbs and UIEvents (#4569)
164164
- Session replay transformed view masking (#4529)
165165
- Load integration from same binary (#4541)
166166
- Masking for fast animations #4574
@@ -194,7 +194,7 @@
194194
### Fixes
195195

196196
- Session replay touch tracking race condition (#4548)
197-
- Use `options.reportAccessibilityIdentifier` for Breadcrumbs and UIEvents (#4569)
197+
- Use `options.reportAccessibilityIdentifier` for Breadcrumbs and UIEvents (#4569)
198198
- Session replay transformed view masking (#4529)
199199
- Load integration from same binary (#4541)
200200
- Masking for fast animations #4574
@@ -209,7 +209,7 @@
209209

210210
### Features
211211

212-
- Transactions for crashes (#4504): Finish the transaction bound to the scope when the app crashes. This __experimental__ feature is disabled by default. You can enable it via the option `enablePersistingTracesWhenCrashing`.
212+
- Transactions for crashes (#4504): Finish the transaction bound to the scope when the app crashes. This **experimental** feature is disabled by default. You can enable it via the option `enablePersistingTracesWhenCrashing`.
213213

214214
### Fixes
215215

@@ -224,7 +224,7 @@
224224

225225
### Features
226226

227-
- Transactions for crashes (#4504): Finish the transaction bound to the scope when the app crashes. This __experimental__ feature is disabled by default. You can enable it via the option `enablePersistingTracesWhenCrashing`.
227+
- Transactions for crashes (#4504): Finish the transaction bound to the scope when the app crashes. This **experimental** feature is disabled by default. You can enable it via the option `enablePersistingTracesWhenCrashing`.
228228

229229
### Fixes
230230

@@ -502,7 +502,7 @@ This bug caused unhandled/crash events to have the unhandled property and mach i
502502
- Don’t force cast to `NSComparisonPredicate` in TERNARY operator (#4232)
503503
- Fix accessing UI API on bg thread in enrichScope (#4245)
504504
- EXC_BAD_ACCESS in SentryMetricProfiler (#4242)
505-
- Missing '#include <sys/_types/_ucontext64.h>' (#4244)
505+
- Missing `#include <sys/_types/_ucontext64.h>` (#4244)
506506
- Rare flush timeout when called in tight loop (#4257)
507507

508508
### Improvements
@@ -602,10 +602,10 @@ This bug caused unhandled/crash events to have the unhandled property and mach i
602602
- Add C++ exception support for `__cxa_rethrow` (#3996)
603603
- Add beforeCaptureScreenshot callback (#4016)
604604
- Disable SIGTERM reporting by default (#4025). We added support
605-
for SIGTERM reporting in the last release and enabled it by default.
606-
For some users, SIGTERM events were verbose and not actionable.
607-
Therefore, we disable it per default in this release. If you'd like
608-
to receive SIGTERM events, set the option `enableSigtermReporting = true`.
605+
for SIGTERM reporting in the last release and enabled it by default.
606+
For some users, SIGTERM events were verbose and not actionable.
607+
Therefore, we disable it per default in this release. If you'd like
608+
to receive SIGTERM events, set the option `enableSigtermReporting = true`.
609609

610610
### Improvements
611611

@@ -714,7 +714,7 @@ The following two features, disabled by default, were mistakenly added to the re
714714
### Features
715715

716716
- Add Metrics API (#3791, #3799): Read our [docs](https://docs.sentry.io/platforms/apple/metrics/) to learn
717-
more about how to use the Metrics API.
717+
more about how to use the Metrics API.
718718
- Pre-main profiling data is now attached to the app start transaction (#3736)
719719
- Release framework without UIKit/AppKit (#3793)
720720
- Add the option swizzleClassNameExcludes (#3813)
@@ -761,14 +761,15 @@ more about how to use the Metrics API.
761761
- Checksum error when resolving the SDK via SPM (#3760)
762762

763763
## 8.22.0
764+
764765
**Warning:** this version is not working with SPM
765766

766767
### Improvements
767768

768-
- __SPM uses a prebuilt XCFramework and remove SentryPrivate (#3623)__:
769-
We now provide a prebuilt XCFramework for SPM, which speeds up your build and allows us to write
770-
more code in Swift. To make this happen, we had to remove the SentryPrivate target for SPM and
771-
CocoaPods, which you shouldn't have included directly.
769+
- **SPM uses a prebuilt XCFramework and remove SentryPrivate (#3623)**:
770+
We now provide a prebuilt XCFramework for SPM, which speeds up your build and allows us to write
771+
more code in Swift. To make this happen, we had to remove the SentryPrivate target for SPM and
772+
CocoaPods, which you shouldn't have included directly.
772773

773774
### Fixes
774775

@@ -780,7 +781,7 @@ CocoaPods, which you shouldn't have included directly.
780781
### Features
781782

782783
- Add support for Sentry [Spotlight](https://spotlightjs.com/) (#3642), which is basically Sentry
783-
for development. Read our [blog post](https://blog.sentry.io/sentry-for-development/) to find out more.
784+
for development. Read our [blog post](https://blog.sentry.io/sentry-for-development/) to find out more.
784785
- Add field `SentrySDK.detectedStartUpCrash` (#3644)
785786
- Automatically profile app launches (#3529)
786787
- Use CocoaPods resource_bundles for PrivacyInfo (#3651)
@@ -796,8 +797,8 @@ for development. Read our [blog post](https://blog.sentry.io/sentry-for-developm
796797
- Finish TTID span when transaction finishes (#3610)
797798
- Don't take screenshot and view hierarchy for app hanging (#3620)
798799
- Remove `free_storage` and `storage_size` from the device context (#3627), because Apple forbids sending
799-
information retrieved via `NSFileSystemFreeSize` and `NSFileSystemSize` off a device; see
800-
[Apple docs](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api?language=objc).
800+
information retrieved via `NSFileSystemFreeSize` and `NSFileSystemSize` off a device; see
801+
[Apple docs](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api?language=objc).
801802
- Make SentryFramesTracker available for HybridSDKs ([#3683](https://github.com/getsentry/sentry-cocoa/pull/3683))
802803
- Make SentrySwizzle available for HybridSDKs ([#3684](https://github.com/getsentry/sentry-cocoa/pull/3684))
803804
- Move headers reference out of "extern C" (#3690)
@@ -807,7 +808,7 @@ information retrieved via `NSFileSystemFreeSize` and `NSFileSystemSize` off a de
807808
### Features
808809

809810
- Add support for Sentry [Spotlight](https://spotlightjs.com/) (#3642), which is basically Sentry
810-
for development. Read our [blog post](https://blog.sentry.io/sentry-for-development/) to find out more.
811+
for development. Read our [blog post](https://blog.sentry.io/sentry-for-development/) to find out more.
811812
- Add field `SentrySDK.detectedStartUpCrash` (#3644)
812813
- Automatically profile app launches (#3529)
813814
- Use CocoaPods resource_bundles for PrivacyInfo (#3651)
@@ -823,8 +824,8 @@ for development. Read our [blog post](https://blog.sentry.io/sentry-for-developm
823824
- Finish TTID span when transaction finishes (#3610)
824825
- Don't take screenshot and view hierarchy for app hanging (#3620)
825826
- Remove `free_storage` and `storage_size` from the device context (#3627), because Apple forbids sending
826-
information retrieved via `NSFileSystemFreeSize` and `NSFileSystemSize` off a device; see
827-
[Apple docs](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api?language=objc).
827+
information retrieved via `NSFileSystemFreeSize` and `NSFileSystemSize` off a device; see
828+
[Apple docs](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api?language=objc).
828829

829830
## 8.20.0
830831

@@ -967,8 +968,8 @@ The XCFramework attached to GitHub releases is now built with Xcode 15.
967968
### Features
968969

969970
- Sentry can now be used without linking UIKit; this is helpful for using the SDK in certain app extension contexts (#3175)
970-
**Note:** this is an experimental feature not yet available for with SPM.
971-
**Warning:** this breaks some SPM integrations. Use 8.14.1 if you integrate using SPM.
971+
**Note:** this is an experimental feature not yet available for with SPM.
972+
**Warning:** this breaks some SPM integrations. Use 8.14.1 if you integrate using SPM.
972973

973974
- GA of MetricKit integration (#3340)
974975

@@ -977,7 +978,6 @@ The MetricKit integration subscribes to [MXHangDiagnostic](https://developer.app
977978
[MXDiskWriteExceptionDiagnostic](https://developer.apple.com/documentation/metrickit/mxdiskwriteexceptiondiagnostic),
978979
and [MXCPUExceptionDiagnostic](https://developer.apple.com/documentation/metrickit/mxcpuexceptiondiagnostic).
979980

980-
981981
## 8.13.1
982982

983983
### Fixes
@@ -1098,7 +1098,7 @@ This change considerably speeds up retrieving stacktraces, which the SDK uses fo
10981098
### Breaking change
10991099

11001100
- Renamed `enableTimeToFullDisplay` to `enableTimeToFullDisplayTracing` (#3106)
1101-
- This is an experimental feature and may change at any time without a major revision.
1101+
- This is an experimental feature and may change at any time without a major revision.
11021102

11031103
## 8.9.0-beta.1
11041104

@@ -1107,7 +1107,6 @@ This change considerably speeds up retrieving stacktraces, which the SDK uses fo
11071107
- Symbolicate locally only when debug is enabled (#3079)
11081108
- Sanitize HTTP info from breadcrumbs, spans and events (#3094)
11091109

1110-
11111110
## 8.8.0
11121111

11131112
### Features
@@ -1173,10 +1172,10 @@ SentrySDK.capture(error: LoginError.wrongUser("12345678"))
11731172

11741173
For the Swift error above Sentry displays:
11751174

1176-
| sentry-cocoa SDK | Title | Description |
1177-
| ----------- | ----------- | ----------- |
1178-
| Since 8.7.0 | `LoginError` | `wrongUser(id: "12345678") (Code: 1)` |
1179-
| Before 8.7.0 | `LoginError` | `Code: 1` |
1175+
| sentry-cocoa SDK | Title | Description |
1176+
| ---------------- | ------------ | ------------------------------------- |
1177+
| Since 8.7.0 | `LoginError` | `wrongUser(id: "12345678") (Code: 1)` |
1178+
| Before 8.7.0 | `LoginError` | `Code: 1` |
11801179

11811180
[Customized error descriptions](https://docs.sentry.io/platforms/apple/usage/#customizing-error-descriptions) have precedence over this feature.
11821181
This change has no impact on grouping of the issues in Sentry.
@@ -1267,6 +1266,7 @@ The `stitchAsyncCode` experimental option has been removed from `SentryOptions`
12671266
## 8.3.0
12681267

12691268
### Important Note
1269+
12701270
This release can cause crashes when Profiling is enabled (#2779). Please update to `8.3.1`.
12711271

12721272
### Fixes
@@ -1367,29 +1367,29 @@ We renamed the default branch from `master` to `main`. We are going to keep the
13671367
- Make `SpanProtocol.data` non nullable (#2409)
13681368
- Mark `- [SpanProtocol setExtraValue:forKey:]` as deprecated (#2413)
13691369
- Make SpanContext immutable (#2408)
1370-
- Remove tags from SpanContext
1371-
- Remove context property from SentrySpan
1370+
- Remove tags from SpanContext
1371+
- Remove context property from SentrySpan
13721372
- Bump minimum supported OS versions to macOS 10.13, iOS 11, tvOS 11, and watchOS 4 (#2414)
13731373
- Make public APIs Swift friendly
1374-
- Rename `SentrySDK.addBreadcrumb(crumb:)` to `SentrySDK.addBreadcrumb(_ crumb:)` (#2416)
1375-
- Rename `SentryScope.add(_ crumb:)` to `SentryScope.addBreadcrumb(_ crumb:)` (#2416)
1376-
- Rename `SentryScope.add(_ attachment:)` to `SentryScope.addAttachment(_ attachment:)` (#2416)
1377-
- Rename `Client` to `SentryClient` (#2403)
1374+
- Rename `SentrySDK.addBreadcrumb(crumb:)` to `SentrySDK.addBreadcrumb(_ crumb:)` (#2416)
1375+
- Rename `SentryScope.add(_ crumb:)` to `SentryScope.addBreadcrumb(_ crumb:)` (#2416)
1376+
- Rename `SentryScope.add(_ attachment:)` to `SentryScope.addAttachment(_ attachment:)` (#2416)
1377+
- Rename `Client` to `SentryClient` (#2403)
13781378
- Remove public APIs
1379-
- Remove `SentryScope.apply(to:)` (#2416)
1380-
- Remove `SentryScope.apply(to:maxBreadcrumb:)` (#2416)
1381-
- Remove `- [SentryOptions initWithDict:didFailWithError:]` (#2404)
1382-
- Remove `- [SentryOptions sdkInfo]` (#2404)
1383-
- Make SentrySession and SentrySDKInfo internal (#2451)
1379+
- Remove `SentryScope.apply(to:)` (#2416)
1380+
- Remove `SentryScope.apply(to:maxBreadcrumb:)` (#2416)
1381+
- Remove `- [SentryOptions initWithDict:didFailWithError:]` (#2404)
1382+
- Remove `- [SentryOptions sdkInfo]` (#2404)
1383+
- Make SentrySession and SentrySDKInfo internal (#2451)
13841384
- Marks App hang's event stacktrace snapshot as true (#2441)
13851385
- Enable user interaction tracing by default (#2442)
13861386
- Remove default attachment content type (#2443)
13871387
- Rename APM tracking feature flags to tracing (#2450)
1388-
- Rename `SentryOptions.enableAutoPerformanceTracking` to `enableAutoPerformanceTracing`
1389-
- Rename `SentryOptions.enableUIViewControllerTracking` to `enableUIViewControllerTracing`
1390-
- Rename `SentryOptions.enablePreWarmedAppStartTracking` to `enablePreWarmedAppStartTracing`
1391-
- Rename `SentryOptions.enableFileIOTracking` to `enableFileIOTracing`
1392-
- Rename `SentryOptions.enableCoreDataTracking` to `enableCoreDataTracing`
1388+
- Rename `SentryOptions.enableAutoPerformanceTracking` to `enableAutoPerformanceTracing`
1389+
- Rename `SentryOptions.enableUIViewControllerTracking` to `enableUIViewControllerTracing`
1390+
- Rename `SentryOptions.enablePreWarmedAppStartTracking` to `enablePreWarmedAppStartTracing`
1391+
- Rename `SentryOptions.enableFileIOTracking` to `enableFileIOTracing`
1392+
- Rename `SentryOptions.enableCoreDataTracking` to `enableCoreDataTracing`
13931393
- SentrySDK.close calls flush, which is a blocking call (#2453)
13941394
- Bump minimum Xcode version to 13 (#2483)
13951395
- Rename `SentryOptions.enableOutOfMemoryTracking` to `SentryOptions.enableWatchdogTerminationTracking` (#2499)
@@ -2348,7 +2348,7 @@ Breaking changes:
23482348

23492349
Features and fixes:
23502350

2351-
- fix: Make public isEqual _Nullable #751
2351+
- fix: Make public isEqual \_Nullable #751
23522352
- feat: Use error domain and code for event message #750
23532353
- feat: Remove SDK frames when attaching stacktrace #739
23542354
- fix: captureException crates a event type=error #746

0 commit comments

Comments
 (0)