Fix update-cgmanifest.ps1 script to produce deterministic output #30055
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.
Problem
The
update-cgmanifest.ps1
script was regenerating the entirecgmanifest.json
file each time it ran, causing the file to show changes in source control even when there were no actual changes to package versions or new packages added.The script had several issues:
Solution
Modified the script to ensure deterministic, consistent output:
Changes Made
$newRegistrations
by package name:$newRegistrations | Sort-Object { $_.component.nuget.name }
[ordered]@{}
syntax to control field orderingtype
beforenuget
,name
beforeversion
Verification
Created comprehensive tests that verify:
Example Before/After
Before: Running the script twice would show differences like:
After: Running the script multiple times produces identical output with zero differences.
This resolves the issue where changes to
cgmanifest.json
files would appear in source control unnecessarily, making it easier to identify actual package version changes.Fixes #30054.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.