Include groupId in the pkg name when create api view request #13040
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fixes an issue where API review requests for Java packages weren't including the groupId in the package name. The change ensures that when a package has a groupId (primarily for Java packages), the API review request uses the format groupId:packageName instead of just the package name.
Key Changes
- Modified the
Submit-Requestfunction to accept and use a group parameter - Added logic to construct a full package name with groupId when available
- Updated the function call to pass the packageInfo.Group field
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| eng/common/scripts/Detect-Api-Changes.ps1 | Added group parameter to Submit-Request function and logic to construct full package name with groupId; also includes trailing whitespace fix on line 83 |
| eng/common/pipelines/templates/steps/validate-all-packages.yml | Added explanatory comment for PackageInfoFiles parameter |
| eng/common/pipelines/templates/steps/create-apireview.yml | Added explanatory comment for PackageInfoFiles parameter |
Comments suppressed due to low confidence (1)
eng/common/scripts/Detect-Api-Changes.ps1:36
- The
$reviewFileNameis still using$packageNameinstead of$fullPackageName. This could cause inconsistencies when the group is present, as the query parameter uses$fullPackageNamebut the review file name uses the ungrouped$packageName. Consider whether the review file name should also include the group, or if this is intentional. If groupId should be included in the filename, use$fullPackageNamehere.
$reviewFileName = "$($packageName)_$($LanguageShort).json"
| $query.Add('repoName', $repoName) | ||
| $query.Add('pullRequestNumber', $PullRequestNumber) | ||
| $query.Add('packageName', $packageName) | ||
| $query.Add('packageName', $fullPackageName) |
There was a problem hiding this comment.
@praveenkuttappan can we merge this change directly or any change needs to make in API view server side?
raych1
requested review from
AlitzelMendez,
helen229,
praveenkuttappan and
weshaggard
|
The following pipelines have been queued for testing: |
Fixed #12506
Test Run