Skip to content

Conversation

@rolfbjarne
Copy link
Member

Switch to using the apicompat tool to detect breaking API changes.

This has a few advantages:

  • It's rather complex to detect breaking changes, and this way we don't have to
    maintain our own code.
  • With apicompat it's easy to perform strict verification that doesn't allow any
    API additions either, which is useful for validating release branches (so this
    PR implements strict verification on release branches as well).
  • With apicompat it's easy to add exclusions (suppressions) to allow an occasional
    API break if we ever wanted to. In fact we have to use this to ignore changes to
    [Experimental] API, which apicompat unfortunately doesn't understand.
  • It allows us to simplify a lot of the code in the mono-api-html, which we strong-armed
    into finding breaking changes without it ever being designed to do so. We still
    keep mono-api-html to create API diffs in both html and markdown.

References:

rolfbjarne and others added 2 commits September 5, 2025 18:37
Switch to using the apicompat tool to detect breaking API changes.

This has a few advantages:

* It's rather complex to detect breaking changes, and this way we don't have to
  maintain our own code.
* With apicompat it's easy to perform strict verification that doesn't allow any
  API additions either, which is useful for validating release branches (so this
  PR implements strict verification on release branches as well).
* With apicompat it's easy to add exclusions (suppressions) to allow an occasional
  API break if we ever wanted to. In fact we have to use this to ignore changes to
  [Experimental] API, which apicompat unfortunately doesn't understand.
* It allows us to simplify a lot of the code in the mono-api-html, which we strong-armed
  into finding breaking changes without it ever being designed to do so. We still
  keep mono-api-html to create API diffs in both html and markdown.

References:

* https://learn.microsoft.com/en-us/dotnet/fundamentals/apicompat/overview
* dotnet/sdk#50637
@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@rolfbjarne rolfbjarne disabled auto-merge September 5, 2025 18:54
@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2
Copy link
Collaborator

✅ [CI Build #919012c] Build passed (Build packages) ✅

Pipeline on Agent
Hash: 919012cd3bffcc61cb5a8be28fdf093f7e3e5471 [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

✅ [PR Build #919012c] Build passed (Detect API changes) ✅

Pipeline on Agent
Hash: 919012cd3bffcc61cb5a8be28fdf093f7e3e5471 [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

✅ API diff for current PR / commit

NET (empty diffs)

✅ API diff vs stable

NET (empty diffs)

ℹ️ Generator diff

Generator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes)

Pipeline on Agent
Hash: 919012cd3bffcc61cb5a8be28fdf093f7e3e5471 [PR build]

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2
Copy link
Collaborator

✅ [CI Build #919012c] Build passed (Build macOS tests) ✅

Pipeline on Agent
Hash: 919012cd3bffcc61cb5a8be28fdf093f7e3e5471 [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

💻 [CI Build #919012c] Tests on macOS X64 - Mac Sonoma (14) passed 💻

All tests on macOS X64 - Mac Sonoma (14) passed.

Pipeline on Agent
Hash: 919012cd3bffcc61cb5a8be28fdf093f7e3e5471 [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

💻 [CI Build #919012c] Tests on macOS M1 - Mac Monterey (12) passed 💻

All tests on macOS M1 - Mac Monterey (12) passed.

Pipeline on Agent
Hash: 919012cd3bffcc61cb5a8be28fdf093f7e3e5471 [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

💻 [CI Build #919012c] Tests on macOS arm64 - Mac Tahoe (26) passed 💻

All tests on macOS arm64 - Mac Tahoe (26) passed.

Pipeline on Agent
Hash: 919012cd3bffcc61cb5a8be28fdf093f7e3e5471 [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

💻 [CI Build #919012c] Tests on macOS M1 - Mac Ventura (13) passed 💻

All tests on macOS M1 - Mac Ventura (13) passed.

Pipeline on Agent
Hash: 919012cd3bffcc61cb5a8be28fdf093f7e3e5471 [PR build]

@vs-mobiletools-engineering-service2

This comment has been minimized.

@rolfbjarne rolfbjarne enabled auto-merge (squash) September 8, 2025 14:40
@vs-mobiletools-engineering-service2
Copy link
Collaborator

💻 [CI Build #919012c] Tests on macOS arm64 - Mac Sequoia (15) passed 💻

All tests on macOS arm64 - Mac Sequoia (15) passed.

Pipeline on Agent
Hash: 919012cd3bffcc61cb5a8be28fdf093f7e3e5471 [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

🚀 [CI Build #919012c] Test results 🚀

Test results

✅ All tests passed on VSTS: test results.

🎉 All 117 tests passed 🎉

Tests counts

✅ cecil: All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (iOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (MacCatalyst): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (macOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (Multiple platforms): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (tvOS): All 1 tests passed. Html Report (VSDrops) Download
✅ framework: All 2 tests passed. Html Report (VSDrops) Download
✅ fsharp: All 4 tests passed. Html Report (VSDrops) Download
✅ generator: All 5 tests passed. Html Report (VSDrops) Download
✅ interdependent-binding-projects: All 4 tests passed. Html Report (VSDrops) Download
✅ introspection: All 6 tests passed. Html Report (VSDrops) Download
✅ linker: All 44 tests passed. Html Report (VSDrops) Download
✅ monotouch (iOS): All 8 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 11 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 9 tests passed. Html Report (VSDrops) Download
✅ monotouch (tvOS): All 8 tests passed. Html Report (VSDrops) Download
✅ msbuild: All 2 tests passed. Html Report (VSDrops) Download
✅ windows: All 3 tests passed. Html Report (VSDrops) Download
✅ xcframework: All 4 tests passed. Html Report (VSDrops) Download
✅ xtro: All 1 tests passed. Html Report (VSDrops) Download

Pipeline on Agent
Hash: 919012cd3bffcc61cb5a8be28fdf093f7e3e5471 [PR build]

@rolfbjarne rolfbjarne merged commit 6ccf639 into xcode26.0 Sep 8, 2025
45 checks passed
@rolfbjarne rolfbjarne deleted the dev/rolf/apicompat branch September 8, 2025 14:49
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