Improve management parameter compatibility review - #62022
Open
Wei Hu (live1206) wants to merge 3 commits into
Open
Improve management parameter compatibility review#62022Wei Hu (live1206) wants to merge 3 commits into
Wei Hu (live1206) wants to merge 3 commits into
Conversation
Use released GA assembly metadata as the authoritative baseline, keep raw optional-parameter differences non-blocking until compiler probes demonstrate a break, and add regression coverage for exact signatures and candidate reporting. Fixes Azure#61975 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Wei Hu (live1206)
requested review from
Arthur Ma (ArthurMa1978),
JoshLove-msft,
Jesse Squire (jsquire) and
m-nash
as code owners
August 13, 2026 04:24
|
Azure Pipelines: Successfully started running 1 pipeline(s). 11 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the management SDK PR review workflow and skill guidance to use the released ApiCompatVersion NuGet assembly (via metadata export) as the authoritative baseline for parameter compatibility checks, and to treat optionality differences as non-blocking until a compiler probe demonstrates a source break.
Changes:
- Add a GA baseline exporter (
Export-GaApiBaseline.ps1) that downloads the released package and emits a GenAPI listing for deterministic comparisons. - Extend the naming scanner to report GA baseline version/signatures and separate parameter-name/order differences from optionality “candidates”.
- Add regression tests and update workflow/skill docs + workflow allowlist domains to support NuGet/ADO feeds.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/mgmt-review.md | Updates the documented review workflow to use exported GA assembly metadata and compiler-probe guidance for optionality. |
| .github/workflows/mgmt-review.lock.yml | Regenerates the gh-aw lock file to reflect updated allowed domains and prompt content. |
| .github/skills/azure-sdk-mgmt-pr-review/test/Check-MgmtNamingRules.tests.ps1 | Adds test coverage for the scanner’s new GA parameter compatibility reporting behavior. |
| .github/skills/azure-sdk-mgmt-pr-review/SKILL.md | Aligns skill guidance with GA-assembly-as-authoritative baseline and non-blocking optionality candidates. |
| .github/skills/azure-sdk-mgmt-pr-review/Export-GaApiBaseline.ps1 | Introduces a script to export GA API listings from released NuGet assemblies using GenAPI. |
| .github/skills/azure-sdk-mgmt-pr-review/Check-MgmtNamingRules.ps1 | Enhances scanner output to include baseline version/signatures and adds PARAMNAME/PARAMORDER checks plus candidate-only optionality findings. |
Suppressed comments (1)
.github/skills/azure-sdk-mgmt-pr-review/Export-GaApiBaseline.ps1:124
- Same restore-source issue as above: restoring the dependency closure with only the Azure DevOps feed can fail when dependencies are only on NuGet.org. Since the workflow now explicitly allows
api.nuget.org, include it as a source here as well.
& dotnet restore $dependencyProject --source 'https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json'
if ($LASTEXITCODE -ne 0) {
throw "Failed to restore the dependency closure for $PackageName $Version."
}
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
Document the repository-approved Azure SDK feed and avoid recursively scanning the full .NET reference-pack tree. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Rely on CI ApiCompat and tagged API files by default, and download released assembly metadata only when a parameter compatibility result needs authoritative confirmation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Summary
ApiCompatVersionassembly as the authoritative parameter baselineValidation
pwsh .github/skills/azure-sdk-mgmt-pr-review/test/Check-MgmtNamingRules.tests.ps1Azure.ResourceManager.AppService1.5.0 (net10.0)Azure.ResourceManager.IotHub1.1.1 (netstandard2.0)gh aw compile mgmt-review --strictFixes #61975
- by copilot