Local and Copilot dev can generate public apis #30500

mattleibow · 2025-07-08T20:47:50Z

Note

Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!

Description of Change

Currently, the only way is to use the IDE and the lightbulb - or manually. This is often not successful and AI still struggles as well.

The new version of the Mono.ApiTools.MSBuildTasks package now has the ability to generate the files and they can be checked in during development to show the actual API changes.

The rules would be if this is release of CI, then it is set to Validate only, and then only if it is debug AND not CI (ie: local) will it enable generation.

Issues Fixed

The pain of trying to get IDEs to actually generate files in a multi-targeted world.

Copilot

Pull Request Overview

This PR enables automatic generation of public API files locally and via Copilot by integrating the updated Mono.ApiTools.MSBuildTasks package, adding conditional logic in the PublicAPI build targets, and recording new API changes.

Remove hard-coded version for Mono.ApiTools.MSBuildTasks and centralize versioning
Introduce PublicApiType conditions and a _GeneratePublicApiFiles target in PublicAPI.targets
Update PublicAPI.Unshipped.txt across TFMs for new API signatures and hide fields

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/SingleProject/Resizetizer/src/Resizetizer.csproj	Drop explicit `Version="0.3.0"` to use central version management
src/PublicAPI.targets	Add `PublicApiType` conditions, conditional analyzer/tasks package refs, and new generate target
src/Controls/src/Core/PublicAPI/*/PublicAPI.Unshipped.txt	Record hiding of `Element.transientNamescope` and updated `FlexLayout.CrossPlatformMeasure`
src/Controls/src/Core/Layout/FlexLayout.cs	Remove pragma warnings around the public `CrossPlatformMeasure` override
src/Controls/src/Core/Element/Element.cs	Remove pragma warnings around the public `transientNamescope` field
eng/Versions.props	Bump `MonoApiToolsMSBuildTasksPackageVersion` to 0.4.0
eng/NuGetVersions.targets	Add `Mono.ApiTools.MSBuildTasks` central package reference

Comments suppressed due to low confidence (4)

src/PublicAPI.targets:40

Add automated tests (unit or integration) covering the new _GeneratePublicApiFiles target to verify that API files are generated correctly under the Generate condition.

  <Target Name="_GeneratePublicApiFiles" AfterTargets="Build" Condition="'$(TargetFramework)' != '' and '$(PublicApiType)' == 'Generate'">

src/Controls/src/Core/Layout/FlexLayout.cs:467

The RS0016 suppression pragmas around this public override were removed. This can lead to public API analyzer warnings. Reintroduce #pragma warning disable RS0016 before and #pragma warning restore RS0016 after the method to limit the suppression scope.

		new public Graphics.Size CrossPlatformMeasure(double widthConstraint, double heightConstraint)

src/Controls/src/Core/Element/Element.cs:507

The pragma disable/restore for RS0016 was removed around this field, causing potential analyzer failures. Add back #pragma warning disable RS0016 above and #pragma warning restore RS0016 below this declaration.

		public INameScope transientNamescope;

src/SingleProject/Resizetizer/src/Resizetizer.csproj:36

Removing the explicit version relies on central version management. Verify that eng/Versions.props defines the correct version to avoid mismatched package versions in local vs CI builds.

    <PackageReference Include="Mono.ApiTools.MSBuildTasks" PrivateAssets="all" />

src/PublicAPI.targets

mattleibow · 2025-07-15T12:46:36Z

/rebase

Currently, the only way is to use the IDE and the lightbulb - or manually. This is often not successful and AI still struggles as well. The new version of the Mono.ApiTools.MSBuildTasks package now has the ability to generate the files and they can be checked in during development to show the actual API changes. Local dev will start generating automatically. The rules would be if this is release of CI, then it is set to Validate only, and then only if it is debug AND not CI (ie: local) will it enable generation.

mattleibow · 2025-07-16T15:25:06Z

/backport to net10.0

github-actions · 2025-07-16T15:25:13Z

Started backporting to net10.0: https://github.com/dotnet/maui/actions/runs/16323633832

mattleibow · 2025-07-16T15:25:34Z

/backport to inflight/current

github-actions · 2025-07-16T15:25:43Z

Started backporting to inflight/current: https://github.com/dotnet/maui/actions/runs/16323643779

* Local and Copilot dev can generate public apis Currently, the only way is to use the IDE and the lightbulb - or manually. This is often not successful and AI still struggles as well. The new version of the Mono.ApiTools.MSBuildTasks package now has the ability to generate the files and they can be checked in during development to show the actual API changes. The rules would be if this is release of CI, then it is set to Validate only, and then only if it is debug AND not CI (ie: local) will it enable generation. # Conflicts: # src/Controls/src/Core/PublicAPI/net-android/PublicAPI.Unshipped.txt # src/Controls/src/Core/PublicAPI/net-ios/PublicAPI.Unshipped.txt # src/Controls/src/Core/PublicAPI/net-maccatalyst/PublicAPI.Unshipped.txt # src/Controls/src/Core/PublicAPI/net-tizen/PublicAPI.Unshipped.txt # src/Controls/src/Core/PublicAPI/net-windows/PublicAPI.Unshipped.txt # src/Controls/src/Core/PublicAPI/net/PublicAPI.Unshipped.txt # src/Controls/src/Core/PublicAPI/netstandard/PublicAPI.Unshipped.txt

* Local and Copilot dev can generate public apis (#30500) * Local and Copilot dev can generate public apis Currently, the only way is to use the IDE and the lightbulb - or manually. This is often not successful and AI still struggles as well. The new version of the Mono.ApiTools.MSBuildTasks package now has the ability to generate the files and they can be checked in during development to show the actual API changes. The rules would be if this is release of CI, then it is set to Validate only, and then only if it is debug AND not CI (ie: local) will it enable generation. # Conflicts: # src/Controls/src/Core/PublicAPI/net-android/PublicAPI.Unshipped.txt # src/Controls/src/Core/PublicAPI/net-ios/PublicAPI.Unshipped.txt # src/Controls/src/Core/PublicAPI/net-maccatalyst/PublicAPI.Unshipped.txt # src/Controls/src/Core/PublicAPI/net-tizen/PublicAPI.Unshipped.txt # src/Controls/src/Core/PublicAPI/net-windows/PublicAPI.Unshipped.txt # src/Controls/src/Core/PublicAPI/net/PublicAPI.Unshipped.txt # src/Controls/src/Core/PublicAPI/netstandard/PublicAPI.Unshipped.txt * regen

mattleibow · 2025-07-22T14:02:38Z

/backport to inflight/current

github-actions · 2025-07-22T14:02:53Z

Started backporting to inflight/current: https://github.com/dotnet/maui/actions/runs/16446585665

github-actions · 2025-07-22T14:03:16Z

@mattleibow backporting to "inflight/current" failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch

Applying: Local and Copilot dev can generate public apis
.git/rebase-apply/patch:183: trailing whitespace.
  <Target Name="_GeneratePublicApiFiles" 
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	eng/NuGetVersions.targets
M	eng/Versions.props
M	src/Controls/src/Core/Element/Element.cs
M	src/Controls/src/Core/Layout/FlexLayout.cs
M	src/Controls/src/Core/PublicAPI/net-android/PublicAPI.Unshipped.txt
M	src/Controls/src/Core/PublicAPI/net-ios/PublicAPI.Unshipped.txt
M	src/Controls/src/Core/PublicAPI/net-maccatalyst/PublicAPI.Unshipped.txt
M	src/Controls/src/Core/PublicAPI/net-tizen/PublicAPI.Unshipped.txt
M	src/Controls/src/Core/PublicAPI/net-windows/PublicAPI.Unshipped.txt
M	src/Controls/src/Core/PublicAPI/net/PublicAPI.Unshipped.txt
M	src/Controls/src/Core/PublicAPI/netstandard/PublicAPI.Unshipped.txt
M	src/PublicAPI.targets
M	src/SingleProject/Resizetizer/src/Resizetizer.csproj
Falling back to patching base and 3-way merge...
Auto-merging src/Controls/src/Core/Element/Element.cs
Auto-merging src/PublicAPI.targets
CONFLICT (content): Merge conflict in src/PublicAPI.targets
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 Local and Copilot dev can generate public apis
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

Copilot AI review requested due to automatic review settings July 8, 2025 20:47

mattleibow requested a review from a team as a code owner July 8, 2025 20:47

mattleibow requested review from jfversluis and rmarinho July 8, 2025 20:47

Copilot AI reviewed Jul 8, 2025

View reviewed changes

src/PublicAPI.targets Show resolved Hide resolved

jonathanpeppers reviewed Jul 8, 2025

View reviewed changes

src/PublicAPI.targets Outdated Show resolved Hide resolved

github-actions bot force-pushed the dev/auto-public branch from 229cf1a to 0d3fe1d Compare July 15, 2025 12:47

mattleibow force-pushed the dev/auto-public branch from 8655e7b to d8140c9 Compare July 15, 2025 14:36

Update PublicAPI.targets

5414c1b

mattleibow merged commit c256626 into main Jul 16, 2025
1 of 34 checks passed

mattleibow deleted the dev/auto-public branch July 16, 2025 15:24

This comment was marked as off-topic.

Sign in to view

github-actions bot mentioned this pull request Jul 16, 2025

[inflight/current] Local and Copilot dev can generate public apis #30660

Closed

mattleibow mentioned this pull request Jul 16, 2025

[net10.0] Local and Copilot dev can generate public apis #30661

Merged

PureWeen added the area-infrastructure CI, Maestro / Coherency, upstream dependencies/versions label Aug 21, 2025

dependabot bot mentioned this pull request Aug 26, 2025

Bump Microsoft.Maui.Graphics from 8.0.100 to 9.0.100 IvyCafe/Medicolor#15

Closed

5 tasks

dependabot bot mentioned this pull request Sep 2, 2025

build: Bump the nuget-deps group with 3 updates microsoft/Document-Knowledge-Mining-Solution-Accelerator#450

Merged

10 tasks

github-actions bot locked and limited conversation to collaborators Sep 21, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Local and Copilot dev can generate public apis #30500

Local and Copilot dev can generate public apis #30500

Uh oh!

mattleibow commented Jul 8, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

mattleibow commented Jul 15, 2025

Uh oh!

Uh oh!

mattleibow commented Jul 16, 2025

Uh oh!

github-actions bot commented Jul 16, 2025

Uh oh!

mattleibow commented Jul 16, 2025

Uh oh!

This comment was marked as off-topic.

github-actions bot commented Jul 16, 2025

Uh oh!

mattleibow commented Jul 22, 2025

Uh oh!

github-actions bot commented Jul 22, 2025

Uh oh!

github-actions bot commented Jul 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Local and Copilot dev can generate public apis #30500

Local and Copilot dev can generate public apis #30500

Uh oh!

Conversation

mattleibow commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Issues Fixed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

mattleibow commented Jul 15, 2025

Uh oh!

Uh oh!

mattleibow commented Jul 16, 2025

Uh oh!

github-actions bot commented Jul 16, 2025

Uh oh!

mattleibow commented Jul 16, 2025

Uh oh!

This comment was marked as off-topic.

github-actions bot commented Jul 16, 2025

Uh oh!

mattleibow commented Jul 22, 2025

Uh oh!

github-actions bot commented Jul 22, 2025

Uh oh!

github-actions bot commented Jul 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mattleibow commented Jul 8, 2025 •

edited

Loading