Skip to content

Sync eng/common directory with azure-sdk-tools for PR 13005 #47355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Sync eng/common directory with azure-sdk-tools for PR 13005 #47355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
3ce3233
Add field for Spec Project Path property
danieljurek Nov 19, 2025
8759e86
Reorder properties
danieljurek Nov 19, 2025
2cd02ac
Cleanup
danieljurek Nov 19, 2025
3fee149
Logging
danieljurek Nov 20, 2025
7bb883f
Move SpecProjectPath into Package-Properties.ps1
danieljurek Nov 20, 2025
40cfb81
Update SpecProjectPath
danieljurek Nov 21, 2025
0744c8d
Fix accidental removal of $title
danieljurek Nov 21, 2025
3023432
Create or update with SpecProjectPath
danieljurek Nov 21, 2025
9854ecc
Revert logic, cannot test
danieljurek Nov 21, 2025
bf27cf4
Revert logic, cannot test
danieljurek Nov 21, 2025
badd251
Revert irrelevant file
danieljurek Nov 21, 2025
9e49997
Retain title
danieljurek Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion eng/common/scripts/Helpers/DevOps-WorkItem-Helpers.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,7 @@ function FindPackageWorkItem($lang, $packageName, $version, $outputCommand = $tr
$fields += "Custom.Generated"
$fields += "Custom.RoadmapState"
$fields += "Microsoft.VSTS.Common.StateChangeDate"
$fields += "Custom.SpecProjectPath"

$fieldList = ($fields | ForEach-Object { "[$_]"}) -join ", "
$query = "SELECT ${fieldList} FROM WorkItems WHERE [Work Item Type] = 'Package'"
Expand Down Expand Up @@ -516,6 +517,7 @@ function CreateOrUpdatePackageWorkItem($lang, $pkg, $verMajorMinor, $existingIte
$pkgType = $pkg.Type
$pkgNewLibrary = $pkg.New
$pkgRepoPath = $pkg.RepoPath
$specProjectPath = $pkg.SpecProjectPath
$serviceName = $pkg.ServiceName
$title = $lang + " - " + $pkg.DisplayName + " - " + $verMajorMinor

Expand All @@ -529,6 +531,10 @@ function CreateOrUpdatePackageWorkItem($lang, $pkg, $verMajorMinor, $existingIte
$fields += "`"ServiceName=${serviceName}`""
$fields += "`"PackageRepoPath=${pkgRepoPath}`""

if ($specProjectPath) {
$fields += "`"Custom.SpecProjectPath=${specProjectPath}`""
}

if ($extraFields) {
$fields += $extraFields
}
Expand Down Expand Up @@ -1256,7 +1262,8 @@ function Update-DevOpsReleaseWorkItem {
[string]$packageNewLibrary = "true",
[string]$relatedWorkItemId = $null,
[string]$tag = $null,
[bool]$inRelease = $true
[bool]$inRelease = $true,
[string]$specProjectPath = ""
)

if (!(Get-Command az -ErrorAction SilentlyContinue)) {
Expand All @@ -1280,6 +1287,7 @@ function Update-DevOpsReleaseWorkItem {
RepoPath = $packageRepoPath
Type = $packageType
New = $packageNewLibrary
SpecProjectPath = $specProjectPath
};

if (!$plannedDate) {
Expand Down Expand Up @@ -1326,6 +1334,18 @@ function Update-DevOpsReleaseWorkItem {
}
$updatedWI = UpdatePackageVersions $workItem -plannedVersions $plannedVersions



if ((!$workItem.fields.ContainsKey('Custom.SpecProjectPath') -and $packageInfo.SpecProjectPath) -or
($workItem.fields.ContainsKey('Custom.SpecProjectPath') -and ($workItem.fields['Custom.SpecProjectPath'] -ne $packageInfo.SpecProjectPath))
) {
Write-Host "Updating SpecProjectPath to '$($packageInfo.SpecProjectPath)' for work item [$($workItem.id)]"
UpdateWorkItem `
-id $workItem.id `
-fields "`"Custom.SpecProjectPath=$($packageInfo.SpecProjectPath)`"" `
-outputCommand $false
}
Comment on lines +1339 to +1347
Copy link

Copilot AI Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The condition logic for updating SpecProjectPath has a potential issue. When $packageInfo.SpecProjectPath is an empty string (not null), the first condition !$workItem.fields.ContainsKey('Custom.SpecProjectPath') -and $packageInfo.SpecProjectPath will evaluate to false (because empty string is falsy in PowerShell), but the second condition will try to compare against the empty string.

Consider being more explicit about null/empty checks:

if ((![string]::IsNullOrEmpty($packageInfo.SpecProjectPath)) -and
    ((!$workItem.fields.ContainsKey('Custom.SpecProjectPath')) -or 
     ($workItem.fields['Custom.SpecProjectPath'] -ne $packageInfo.SpecProjectPath)))

This ensures we only update when there's actually a non-empty value to set, and properly handles both missing fields and value mismatches.

Copilot uses AI. Check for mistakes.

Write-Host "Release tracking item is at https://dev.azure.com/azure-sdk/Release/_workitems/edit/$($updatedWI.id)/"
return $true
}
8 changes: 8 additions & 0 deletions eng/common/scripts/Package-Properties.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ class PackageProps {
[HashTable]$ArtifactDetails
[HashTable]$CIParameters

# Path from root of azure-rest-api-specs repo to spec project (read from
# tsp-location.yaml if it exists in the package directory)
[string]$SpecProjectPath

PackageProps([string]$name, [string]$version, [string]$directoryPath, [string]$serviceDirectory) {
$this.Initialize($name, $version, $directoryPath, $serviceDirectory)
}
Expand Down Expand Up @@ -61,6 +65,10 @@ class PackageProps {
$this.ChangeLogPath = $null
}

if (Test-Path (Join-Path $directoryPath 'tsp-location.yaml')) {
$this.SpecProjectPath = (LoadFrom-Yaml (Join-Path $directoryPath 'tsp-location.yaml')).directory
Copy link

Copilot AI Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code assumes that the tsp-location.yaml file will have a directory property, but there's no null check if LoadFrom-Yaml returns null or if the returned object doesn't have a directory property. This could cause a runtime error if the YAML file is malformed or doesn't contain the expected structure.

Consider adding validation:

if (Test-Path (Join-Path $directoryPath 'tsp-location.yaml')) {
    $tspLocation = LoadFrom-Yaml (Join-Path $directoryPath 'tsp-location.yaml')
    if ($tspLocation -and $tspLocation.directory) {
        $this.SpecProjectPath = $tspLocation.directory
    }
}
Suggested change
$this.SpecProjectPath = (LoadFrom-Yaml (Join-Path $directoryPath 'tsp-location.yaml')).directory
$tspLocation = LoadFrom-Yaml (Join-Path $directoryPath 'tsp-location.yaml')
if ($tspLocation -and $tspLocation.directory) {
$this.SpecProjectPath = $tspLocation.directory
}

Copilot uses AI. Check for mistakes.
}

$this.CIParameters = @{"CIMatrixConfigs" = @()}
$this.InitializeCIArtifacts()
}
Expand Down
1 change: 1 addition & 0 deletions eng/common/scripts/Save-Package-Properties.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ foreach ($pkg in $allPackageProperties)
if (-not [System.String]::IsNullOrEmpty($pkg.Group)) {
Write-Host "GroupId: $($pkg.Group)"
}
Write-Host "Spec Project Path: $($pkg.SpecProjectPath)"
Write-Host "Release date: $($pkg.ReleaseStatus)"
$configFilePrefix = $pkg.Name

Expand Down
3 changes: 2 additions & 1 deletion eng/common/scripts/Validate-All-Packages.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,8 @@ function CreateUpdatePackageWorkItem($pkgInfo)
-packageNewLibrary $pkgInfo.IsNewSDK `
-serviceName "unknown" `
-packageDisplayName "unknown" `
-inRelease $IsReleaseBuild
-inRelease $IsReleaseBuild `
-specProjectPath $pkgInfo.SpecProjectPath

if (-not $result)
{
Expand Down