ci: fix dirty-check for generated Cocoa bindings by jpnurmi · Pull Request #4600 · getsentry/sentry-dotnet

jpnurmi · 2025-10-06T08:23:47Z

Fix the dirty-check which ensures that the committed versions of src/Sentry.Bindings.Cocoa/ApiDefinitions.cs and StructsAndDefinitions.cs are up-to-date after Cocoa SDK updates, as they are automatically re-generated by the build system:

sentry-dotnet/src/Sentry.Bindings.Cocoa/Sentry.Bindings.Cocoa.csproj

Lines 132 to 134 in ad849d4

    
           <Exec Command="pwsh ../../scripts/generate-cocoa-bindings.ps1" /> 
        
           <!-- See https://github.com/getsentry/sentry-dotnet/pull/2558 --> 
        
           <Exec Condition="'$(GITHUB_ACTIONS)' == 'true'" Command="pwsh ../../scripts/dirty-check.ps1 -PathToCheck $(MSBuildThisFileDirectory)" />

The problem was that sentry-cocoa.properties and generate-cocoa-bindings.ps1 alone were not sufficient inputs for MSBuild to trigger _GenerateSentryCocoaBindings, so the bindings were not re-generated in the CI. Adding framework headers, which are the effective sources for the bindings, helps. With this change, the build / .NET (macos) CI job fails with:

Generating bindings with Objective Sharpie.
[...]
  Done.
  Patching /Users/runner/work/sentry-dotnet/sentry-dotnet/src/Sentry.Bindings.Cocoa/StructsAndEnums.cs
  Patching /Users/runner/work/sentry-dotnet/sentry-dotnet/src/Sentry.Bindings.Cocoa/ApiDefinitions.cs
  diff --git a/src/Sentry.Bindings.Cocoa/ApiDefinitions.cs b/src/Sentry.Bindings.Cocoa/ApiDefinitions.cs
  index f33b1c6..2c076dd 100644
  --- a/src/Sentry.Bindings.Cocoa/ApiDefinitions.cs
  +++ b/src/Sentry.Bindings.Cocoa/ApiDefinitions.cs
  @@ -416,9 +416,9 @@ interface SentryEnvelopeItemHeader : SentrySerializable
       [Export ("initWithType:length:filenname:contentType:")]
       NativeHandle Constructor (string type, nuint length, string filename, string contentType);
   
  -    // -(instancetype _Nonnull)initWithType:(NSString * _Nonnull)type length:(NSUInteger)length contentType:(NSString * _Nonnull)contentType itemCount:(NSNumber * _Nonnull)itemCount;
  +    // -(instancetype _Nonnull)initWithType:(NSString * _Nonnull)type length:(NSUInteger)length contentType:(NSString * _Nullable)contentType itemCount:(NSNumber * _Nonnull)itemCount;
       [Export ("initWithType:length:contentType:itemCount:")]
  -    NativeHandle Constructor (string type, nuint length, string contentType, NSNumber itemCount);
  +    NativeHandle Constructor (string type, nuint length, [NullAllowed] string contentType, NSNumber itemCount);
   
       // @property (readonly, copy, nonatomic) NSString * _Nonnull type;
       [Export ("type")]
  Write-Error: /Users/runner/work/sentry-dotnet/sentry-dotnet/scripts/dirty-check.ps1:14
  Line |
    14 |      Write-Error "$GuidanceOnFailure"
       |      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
       | Dirty files detected.
/Users/runner/work/sentry-dotnet/sentry-dotnet/src/Sentry.Bindings.Cocoa/Sentry.Bindings.Cocoa.csproj(134,5): error MSB3073: The command "pwsh ../../scripts/dirty-check.ps1 -PathToCheck /Users/runner/work/sentry-dotnet/sentry-dotnet/src/Sentry.Bindings.Cocoa/" exited with code 1. [TargetFramework=once]

Came up in:

Remove Headers and Modules from SentryCocoaFramework before packing #4533 (comment)

#skip-changelog

codecov · 2025-10-06T08:37:31Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.49%. Comparing base (ad849d4) to head (95460b9).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4600      +/-   ##
==========================================
+ Coverage   73.45%   73.49%   +0.03%     
==========================================
  Files         482      482              
  Lines       17678    17678              
  Branches     3493     3493              
==========================================
+ Hits        12986    12993       +7     
+ Misses       3801     3797       -4     
+ Partials      891      888       -3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

jamescrosswell · 2025-10-06T21:18:28Z

src/Sentry.Bindings.Cocoa/Sentry.Bindings.Cocoa.csproj

    <SentryCocoaVersion>$([System.Text.RegularExpressions.Regex]::Match($(SentryCocoaProperties), 'version\s*=\s*([^\s]+)').Groups[1].Value)</SentryCocoaVersion>
    <SentryCocoaFramework>$(SentryCocoaCache)Sentry-$(SentryCocoaVersion).xcframework</SentryCocoaFramework>
-    <SentryCocoaBindingInputs>../../modules/sentry-cocoa.properties;../../scripts/generate-cocoa-bindings.ps1</SentryCocoaBindingInputs>
+    <SentryCocoaBindingInputs>../../modules/sentry-cocoa.properties;../../scripts/generate-cocoa-bindings.ps1;$(SentryCocoaFrameworkHeaders)**/*.h</SentryCocoaBindingInputs>


Strange that the headers could change without the sentry-cocoa.properties changing (i.e. the version of the Sentry Cocoa SDK changing)... but yeah sure, the headers are ultimately what drives the generated code.

ci: add dirty-check for generated Cocoa bindings

ad6aaff

jpnurmi added 3 commits October 6, 2025 12:49

Fix SentryCocoaBindingInputs

62de31f

Use SentryCocoaCache

eb7cea3

Remove unnecessary extra dirty check

820efed

jpnurmi changed the title ~~ci: add dirty-check for generated Cocoa bindings~~ ci: fix dirty-check for generated Cocoa bindings Oct 6, 2025

Commit up-to-date ApiDefinitions.cs

95460b9

jpnurmi marked this pull request as ready for review October 6, 2025 19:42

jpnurmi requested review from Flash0ver and jamescrosswell as code owners October 6, 2025 19:42

jamescrosswell reviewed Oct 6, 2025

View reviewed changes

jamescrosswell approved these changes Oct 6, 2025

View reviewed changes

jamescrosswell merged commit 3dd2803 into main Oct 6, 2025
34 checks passed

jamescrosswell deleted the ci/dirty-check-cocoa-bindings branch October 6, 2025 21:20

alexsohn1126 pushed a commit that referenced this pull request Oct 11, 2025

ci: fix dirty-check for generated Cocoa bindings (#4600)

cd6d292

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

ci: fix dirty-check for generated Cocoa bindings#4600

ci: fix dirty-check for generated Cocoa bindings#4600
jamescrosswell merged 5 commits intomainfrom
ci/dirty-check-cocoa-bindings

jpnurmi commented Oct 6, 2025 •

edited

Loading

Uh oh!

codecov bot commented Oct 6, 2025 •

edited

Loading

Uh oh!

jamescrosswell Oct 6, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	<Exec Command="pwsh ../../scripts/generate-cocoa-bindings.ps1" />
	<!-- See https://github.com/getsentry/sentry-dotnet/pull/2558 -->
	<Exec Condition="'$(GITHUB_ACTIONS)' == 'true'" Command="pwsh ../../scripts/dirty-check.ps1 -PathToCheck $(MSBuildThisFileDirectory)" />

Uh oh!

Comments

Conversation

jpnurmi commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jamescrosswell Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jpnurmi commented Oct 6, 2025 •

edited

Loading

codecov bot commented Oct 6, 2025 •

edited

Loading