Add overload for ProjectCollection constructor to prevent binary breaking change#12296
Merged
YuliiaKovalova merged 1 commit intomainfrom Aug 7, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR addresses a binary-breaking change in the ProjectCollection constructors by adding back the original constructor signature to maintain backward compatibility. The solution forwards calls to the new constructor with a default value for the new parameter.
- Added overloaded constructor with original signature to maintain binary compatibility
- Removed compatibility suppressions that were hiding the breaking change
- New constructor forwards to the extended version with
enableTargetOutputLogging: falseas default
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Build/Definition/ProjectCollection.cs | Adds overloaded constructor that forwards to new signature with default parameter |
| src/Build/CompatibilitySuppressions.xml | Removes compatibility suppressions for the ProjectCollection constructor |
SimaTian
approved these changes
Aug 6, 2025
baronfel
force-pushed
the
fix-logger-related-api-breaking-change
branch
from
d3af420 to
a8e596d
Compare
YuliiaKovalova
approved these changes
Aug 7, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
#12082 introduced a binary-breaking change to the ProjectCollection constructors, which is breaking VMR codeflow at dotnet/dotnet#1764.
Changes Made
Made the new change in a binary-compatible way by adding the old constructor signature and forwarding to the new constructor with a default value set for the new parameter. This also meant that we get to remove the CompatibilitySuppression, which should have been a red flag in the first place.