. (Join-Path $PSScriptRoot .. SemVer.ps1) $ReleaseDevOpsOrgParameters = @("--organization", "https://dev.azure.com/azure-sdk") $ReleaseDevOpsCommonParameters = $ReleaseDevOpsOrgParameters + @("--output", "json") $ReleaseDevOpsCommonParametersWithProject = $ReleaseDevOpsCommonParameters + @("--project", "Release") # This is used to determine whether or not the az login and azure-devops extension # install have already been completed. $global:AzLoginAndDevOpsExtensionInstallComplete = $false $global:HasDevOpsAccess = $false function Get-DevOpsRestHeaders() { # Get a temp access token from the logged in az cli user for azure devops resource $headerAccessToken = (az account get-access-token --resource "499b84ac-1321-427f-aa17-267ca6975798" --query "accessToken" --output tsv) if ([System.String]::IsNullOrEmpty($headerAccessToken)) { throw "Unable to create the DevOpsRestHeader due to access token being null or empty. The caller needs to be logged in with az login to an account with enough permissions to edit work items in the azure-sdk Release team project." } $headers = @{ Authorization = "Bearer $headerAccessToken" } return $headers } # Function was created from the same code being in Update-DevOps-Release-WorkItem.ps1 # and Validate-Package.ps1. The global variable is used to prevent az commands from # being rerun multiple times function CheckAzLoginAndDevOpsExtensionInstall() { if (-not $global:AzLoginAndDevOpsExtensionInstallComplete) { az account show *> $null if (!$?) { Write-Host 'Running az login...' az login *> $null } az extension show -n azure-devops *> $null if (!$?){ az extension add --name azure-devops } else { # Force update the extension to the latest version if it was already installed # this is needed to ensure we have the authentication issue fixed from earlier versions az extension update -n azure-devops *> $null } $global:AzLoginAndDevOpsExtensionInstallComplete = $true } } function CheckDevOpsAccess() { if (-not $global:HasDevOpsAccess) { # Dummy test query to validate permissions $query = "SELECT [System.ID] FROM WorkItems WHERE [Work Item Type] = 'Package' AND [Package] = 'azure-sdk-template'" $response = Invoke-RestMethod -Method POST ` -Uri "https://dev.azure.com/azure-sdk/Release/_apis/wit/wiql/?api-version=6.0" ` -Headers (Get-DevOpsRestHeaders) -Body "{ ""query"": ""$query"" }" -ContentType "application/json" | ConvertTo-Json -Depth 10 | ConvertFrom-Json -AsHashTable if ($response -isnot [HashTable] -or !$response.ContainsKey("workItems")) { throw "Failed to run test query against Azure DevOps. Please ensure you are logged into the public azure cloud. Consider running 'az logout' and then 'az login'." } $global:HasDevOpsAccess = $true } } function Invoke-AzBoardsCmd($subCmd, $parameters, $output = $true) { $azCmdStr = "az boards ${subCmd} $($parameters -join ' ')" if ($output) { Write-Host $azCmdStr } $response = Invoke-Expression "$azCmdStr" | ConvertFrom-Json -AsHashtable if ($LASTEXITCODE -ne 0) { Write-Host "ERROR command failed: $azCmdStr" } return $response } function Invoke-Query($fields, $wiql, $output = $true) { #POST https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql?timePrecision={timePrecision}&$top={$top}&api-version=6.1-preview.2 $body = @" { "query": "$wiql" } "@ if ($output) { Write-Host "Executing query $wiql" } $response = Invoke-RestMethod -Method POST ` -Uri "https://dev.azure.com/azure-sdk/Release/_apis/wit/wiql/?`$top=100000&api-version=6.0" ` -Headers (Get-DevOpsRestHeaders) -Body $body -ContentType "application/json" | ConvertTo-Json -Depth 10 | ConvertFrom-Json -AsHashTable if ($response -isnot [HashTable] -or !$response.ContainsKey("workItems") -or $response.workItems.Count -eq 0) { Write-Verbose "Query returned no items. $wiql" return ,@() } $workItems = @() $i = 0 do { $idBatch = @() while ($idBatch.Count -lt 200 -and $i -lt $response.workItems.Count) { $idBatch += $response.workItems[$i].id $i++ } $uri = "https://dev.azure.com/azure-sdk/Release/_apis/wit/workitems?ids=$($idBatch -join ',')&fields=$($fields -join ',')&api-version=6.0" Write-Verbose "Pulling work items $uri " $batchResponse = Invoke-RestMethod -Method GET -Uri $uri ` -Headers (Get-DevOpsRestHeaders) -ContentType "application/json" -MaximumRetryCount 3 | ConvertTo-Json -Depth 10 | ConvertFrom-Json -AsHashTable if ($batchResponse.value) { $batchResponse.value | ForEach-Object { $workItems += $_ } } else { Write-Warning "Batch return no items from $uri" } } while ($i -lt $response.workItems.Count) if ($output) { Write-Host "Query return $($workItems.Count) items" } return $workItems } function BuildHashKeyNoNull() { $filterNulls = $args | Where-Object { $_ } # if we had any nulls then return null if (!$filterNulls -or $args.Count -ne $filterNulls.Count) { return $null } return BuildHashKey $args } function BuildHashKey() { # if no args or the first arg is null return null if ($args.Count -lt 1 -or !$args[0]) { return $null } # exclude null values $keys = $args | Where-Object { $_ } return $keys -join "|" } $parentWorkItems = @{} function FindParentWorkItem($serviceName, $packageDisplayName, $outputCommand = $false, $ignoreReleasePlannerTests = $true, $tag = $null) { $key = BuildHashKey $serviceName $packageDisplayName if ($key -and $parentWorkItems.ContainsKey($key)) { return $parentWorkItems[$key] } if ($serviceName) { $serviceCondition = "[ServiceName] = '${serviceName}'" if ($packageDisplayName) { $serviceCondition += " AND [PackageDisplayName] = '${packageDisplayName}'" } else { $serviceCondition += " AND [PackageDisplayName] = ''" } } else { $serviceCondition = "[ServiceName] <> ''" } if ($tag) { $serviceCondition += " AND [Tags] CONTAINS '${tag}'" } if($ignoreReleasePlannerTests){ $serviceCondition += " AND [Tags] NOT CONTAINS 'Release Planner App Test'" } $query = "SELECT [ID], [ServiceName], [PackageDisplayName], [Parent] FROM WorkItems WHERE [Work Item Type] = 'Epic' AND ${serviceCondition}" $fields = @("System.Id", "Custom.ServiceName", "Custom.PackageDisplayName", "System.Parent", "System.Tags") $workItems = Invoke-Query $fields $query $outputCommand foreach ($wi in $workItems) { $localKey = BuildHashKey $wi.fields["Custom.ServiceName"] $wi.fields["Custom.PackageDisplayName"] if (!$localKey) { continue } if ($parentWorkItems.ContainsKey($localKey) -and $parentWorkItems[$localKey].id -ne $wi.id) { Write-Warning "Already found parent [$($parentWorkItems[$localKey].id)] with key [$localKey], using that one instead of [$($wi.id)]." } else { Write-Verbose "[$($wi.id)]$localKey - Cached" $parentWorkItems[$localKey] = $wi } } if ($key -and $parentWorkItems.ContainsKey($key)) { return $parentWorkItems[$key] } return $null } $packageWorkItems = @{} $packageWorkItemWithoutKeyFields = @{} function FindLatestPackageWorkItem($lang, $packageName, $groupId = $null, $outputCommand = $true, $ignoreReleasePlannerTests = $true, $tag = $null) { # Cache all the versions of this package and language work items $null = FindPackageWorkItem $lang $packageName -includeClosed $true -outputCommand $outputCommand -ignoreReleasePlannerTests $ignoreReleasePlannerTests -tag $tag -groupId $groupId $latestWI = $null foreach ($wi in $packageWorkItems.Values) { if ($wi.fields["Custom.Language"] -ne $lang) { continue } if ($wi.fields["Custom.Package"] -ne $packageName) { continue } if ($groupId -and $wi.fields["Custom.GroupId"] -ne $groupId) { continue } if (!$latestWI) { $latestWI = $wi continue } if (($wi.fields["Custom.PackageVersionMajorMinor"] -as [Version]) -gt ($latestWI.fields["Custom.PackageVersionMajorMinor"] -as [Version])) { $latestWI = $wi } } return $latestWI } function FindPackageWorkItem($lang, $packageName, $version, $groupId = $null, $outputCommand = $true, $includeClosed = $false, $ignoreReleasePlannerTests = $true, $tag = $null) { $keyArgs = @($lang, $packageName, $version) if (![string]::IsNullOrWhiteSpace($groupId)) { $keyArgs += $groupId } $key = BuildHashKeyNoNull @keyArgs if ($key -and $packageWorkItems.ContainsKey($key)) { return $packageWorkItems[$key] } $fields = @() $fields += "System.ID" $fields += "System.State" $fields += "System.AssignedTo" $fields += "System.Parent" $fields += "System.Tags" $fields += "Custom.Language" $fields += "Custom.Package" $fields += "Custom.GroupId" $fields += "Custom.PackageDisplayName" $fields += "System.Title" $fields += "Custom.PackageType" $fields += "Custom.PackageTypeNewLibrary" $fields += "Custom.PackageVersionMajorMinor" $fields += "Custom.PackageRepoPath" $fields += "Custom.ServiceName" $fields += "Custom.PlannedPackages" $fields += "Custom.ShippedPackages" $fields += "Custom.PackageBetaVersions" $fields += "Custom.PackageGAVersion" $fields += "Custom.PackagePatchVersions" $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'" if (!$includeClosed -and !$lang) { $query += " AND [State] <> 'No Active Development' AND [PackageTypeNewLibrary] = true" } if ($lang) { $query += " AND [Language] = '${lang}'" } if ($packageName) { $query += " AND [Package] = '${packageName}'" } if ($groupId) { $query += " AND [GroupId] = '${groupId}'" } if ($version) { $query += " AND [PackageVersionMajorMinor] = '${version}'" } if ($tag) { $query += " AND [Tags] CONTAINS '${tag}'" } if($ignoreReleasePlannerTests){ $query += " AND [Tags] NOT CONTAINS 'Release Planner App Test'" } $workItems = Invoke-Query $fields $query $outputCommand foreach ($wi in $workItems) { $localKeyArgs = @($wi.fields["Custom.Language"], $wi.fields["Custom.Package"], $wi.fields["Custom.PackageVersionMajorMinor"]) if (![string]::IsNullOrWhiteSpace($wi.fields["Custom.GroupId"])) { $localKeyArgs += $wi.fields["Custom.GroupId"] } $localKey = BuildHashKeyNoNull @localKeyArgs if (!$localKey) { $packageWorkItemWithoutKeyFields[$wi.id] = $wi Write-Host "Skipping package [$($wi.id)]$($wi.fields['System.Title']) which is missing required fields language, package, or version." continue } if ($packageWorkItems.ContainsKey($localKey) -and $packageWorkItems[$localKey].id -ne $wi.id) { Write-Warning "Already found package [$($packageWorkItems[$localKey].id)] with key [$localKey], using that one instead of [$($wi.id)]." } else { Write-Verbose "Caching package [$($wi.id)] for [$localKey]" $packageWorkItems[$localKey] = $wi } } if ($key -and $packageWorkItems.ContainsKey($key)) { return $packageWorkItems[$key] } return $null } function InitializeWorkItemCache($outputCommand = $true, $includeClosed = $false, $ignoreReleasePlannerTests = $true) { # Pass null to cache all service parents $null = FindParentWorkItem -serviceName $null -packageDisplayName $null -outputCommand $outputCommand -ignoreReleasePlannerTests $ignoreReleasePlannerTests # Pass null to cache all the package items $null = FindPackageWorkItem -lang $null -packageName $null -version $null -outputCommand $outputCommand -includeClosed $includeClosed -ignoreReleasePlannerTests $ignoreReleasePlannerTests } function GetCachedPackageWorkItems() { return $packageWorkItems.Values } function UpdateWorkItemParent($childWorkItem, $parentWorkItem, $outputCommand = $true) { $childId = $childWorkItem.id $existingParentId = $childWorkItem.fields["System.Parent"] $newParentId = $parentWorkItem.id if ($existingParentId -eq $newParentId) { return } CreateWorkItemParent $childId $newParentId $existingParentId -outputCommand $outputCommand $childWorkItem.fields["System.Parent"] = $newParentId } function CreateWorkItemParent($id, $parentId, $oldParentId, $outputCommand = $true) { # Have to remove old parent first if you want to add a new parent. if ($oldParentId) { $parameters = $ReleaseDevOpsCommonParameters $parameters += "--yes" $parameters += "--id", $id $parameters += "--relation-type", "parent" $parameters += "--target-id", $oldParentId Invoke-AzBoardsCmd "work-item relation remove" $parameters $outputCommand | Out-Null } $parameters = $ReleaseDevOpsCommonParameters $parameters += "--id", $id $parameters += "--relation-type", "parent" $parameters += "--target-id", $parentId Invoke-AzBoardsCmd "work-item relation add" $parameters $outputCommand | Out-Null } function CheckUser($user) { $azCmdStr = "az devops user show --user ${user} $($ReleaseDevOpsCommonParameters -join ' ')" Invoke-Expression "$azCmdStr" | Out-Null if ($LASTEXITCODE -ne 0) { return $false } return $true } function CreateWorkItem($title, $type, $iteration, $area, $fields, $assignedTo, $parentId, $relatedId = $null, $outputCommand = $true, $tag = $null) { $parameters = $ReleaseDevOpsCommonParametersWithProject $parameters += "--title", "`"${title}`"" $parameters += "--type", "`"${type}`"" $parameters += "--iteration", "`"${iteration}`"" $parameters += "--area", "`"${area}`"" if ($assignedTo -and (CheckUser $assignedTo)) { $parameters += "--assigned-to", "`"${assignedTo}`"" } if ($tag) { if ($fields) { $fields += "`"System.Tags=${tag}`"" } else { $parameters += "--fields" $parameters += "`"System.Tags=${tag}`"" } } if ($fields) { $parameters += "--fields" $parameters += $fields } Write-Host "Creating work item" $workItem = Invoke-AzBoardsCmd "work-item create" $parameters $outputCommand $workItemId = $workItem.id Write-Host "Created work item [$workItemId]." if ($parentId) { CreateWorkItemRelation $workItemId $parentId "parent" $outputCommand } # Add a work item as related if given. if ($relatedId) { CreateWorkItemRelation $workItemId $relatedId "Related" $outputCommand } return $workItem } function CreateWorkItemRelation($id, $relatedId, $relationType, $outputCommand = $true) { $parameters = $ReleaseDevOpsCommonParameters $parameters += "--id", $id $parameters += "--relation-type", $relationType $parameters += "--target-id", $relatedId Write-Host "Updating work item [$relatedId] as [$relationType] of [$id]." Invoke-AzBoardsCmd "work-item relation add" $parameters $outputCommand | Out-Null } function UpdateWorkItem($id, $fields, $title, $state, $assignedTo, $outputCommand = $true) { $parameters = $ReleaseDevOpsCommonParameters $parameters += "--id", $id if ($title) { $parameters += "--title", "`"${title}`"" } if ($state) { $parameters += "--state", "`"${state}`"" } if ($assignedTo -and (CheckUser $assignedTo)) { $parameters += "--assigned-to", "`"${assignedTo}`"" } if ($fields) { $parameters += "--fields" $parameters += $fields } return Invoke-AzBoardsCmd "work-item update" $parameters $outputCommand } function UpdatePackageWorkItemReleaseState($id, $state, $releaseType, $outputCommand = $true) { $fields = "`"Custom.ReleaseType=${releaseType}`"" return UpdateWorkItem -id $id -state $state -fields $fields -outputCommand $outputCommand } function FindOrCreateClonePackageWorkItem($lang, $pkg, $verMajorMinor, $allowPrompt = $false, $outputCommand = $false, $relatedId = $null, $tag= $null, $ignoreReleasePlannerTests = $true) { $workItem = FindPackageWorkItem -lang $lang -packageName $pkg.Package -version $verMajorMinor -includeClosed $true -outputCommand $outputCommand -tag $tag -ignoreReleasePlannerTests $ignoreReleasePlannerTests -groupId $pkg.GroupId if (!$workItem) { $latestVersionItem = FindLatestPackageWorkItem -lang $lang -packageName $pkg.Package -outputCommand $outputCommand -tag $tag -ignoreReleasePlannerTests $ignoreReleasePlannerTests -groupId $pkg.GroupId $assignedTo = "me" $extraFields = @() if ($latestVersionItem) { Write-Verbose "Copying data from latest matching [$($latestVersionItem.id)] with version $($latestVersionItem.fields["Custom.PackageVersionMajorMinor"])" if ($latestVersionItem.fields["System.AssignedTo"]) { $assignedTo = $latestVersionItem.fields["System.AssignedTo"]["uniqueName"] } $pkg.DisplayName = $latestVersionItem.fields["Custom.PackageDisplayName"] $pkg.ServiceName = $latestVersionItem.fields["Custom.ServiceName"] if (!$pkg.RepoPath -and $pkg.RepoPath -ne "NA" -and $pkg.fields["Custom.PackageRepoPath"]) { $pkg.RepoPath = $pkg.fields["Custom.PackageRepoPath"] } if ($latestVersionItem.fields["Custom.Generated"]) { $extraFields += "`"Generated=" + $latestVersionItem.fields["Custom.Generated"] + "`"" } if ($latestVersionItem.fields["Custom.RoadmapState"]) { $extraFields += "`"RoadmapState=" + $latestVersionItem.fields["Custom.RoadmapState"] + "`"" } } if ($allowPrompt) { if (!$pkg.DisplayName) { Write-Host "Display name is used to identify this package across languages and is usually the friendly name (i.e. For 'Azure Anomaly Detector' it would be 'Anomaly Detector'. For 'Azure Cognitive Search' it would be 'Search'.). See https://aka.ms/azsdk/mark-release-status for more info." while (($readInput = Read-Host -Prompt "Input the display name") -eq "") { } $packageInfo.DisplayName = $readInput } if (!$pkg.ServiceName) { Write-Host "This is the friendly service name for this package that is used to align it with other packages and languages (i.e., no need to include 'Azure' or 'Microsoft' in the title). The service name is sometimes the same as the `Package Display Name` if there is only one package for a service. (i.e. For 'Azure Anomaly Detector' it would be 'Anomaly Detector'). For services that ship multiple packages be sure to list the service only. (i.e. For 'Schema Registry Avro', the service name is just 'Schema Registry'; For 'Key Vault Certificates', the service name is simply Key Vault.). See https://aka.ms/azsdk/mark-release-status for more info." while (($readInput = Read-Host -Prompt "Input the service name") -eq "") { } $packageInfo.ServiceName = $readInput } } $workItem = CreateOrUpdatePackageWorkItem $lang $pkg $verMajorMinor -existingItem $null -assignedTo $assignedTo -extraFields $extraFields -outputCommand $outputCommand -relatedId $relatedId -tag $tag -ignoreReleasePlannerTests $ignoreReleasePlannerTests } return $workItem } function CreateOrUpdatePackageWorkItem($lang, $pkg, $verMajorMinor, $existingItem, $assignedTo = $null, $extraFields = $null, $outputCommand = $true, $relatedId = $null, $tag = $null, $ignoreReleasePlannerTests = $true) { if (!$lang -or !$pkg -or !$verMajorMinor) { Write-Host "Cannot create or update because one of lang, pkg or verMajorMinor aren't set. [$lang|$($pkg.Package)|$verMajorMinor]" return } # PackageProp object uses Group, while other places use GroupId, such as in work item fields and package csv files. $pkgGroupId = if ($pkg.PSObject.Properties.Name -contains "GroupId") { $pkg.GroupId } elseif ($pkg.PSObject.Properties.Name -contains "Group") { $pkg.Group } else { $null } $pkgName = $pkg.Package $pkgDisplayName = $pkg.DisplayName $pkgType = $pkg.Type $pkgNewLibrary = $pkg.New $pkgRepoPath = $pkg.RepoPath $serviceName = $pkg.ServiceName $title = $lang + " - " + $pkg.DisplayName + " - " + $verMajorMinor $fields = @() $fields += "`"Language=${lang}`"" $fields += "`"Package=${pkgName}`"" $fields += "`"GroupId=${pkgGroupId}`"" $fields += "`"PackageDisplayName=${pkgDisplayName}`"" $fields += "`"PackageType=${pkgType}`"" $fields += "`"PackageTypeNewLibrary=${pkgNewLibrary}`"" $fields += "`"PackageVersionMajorMinor=${verMajorMinor}`"" $fields += "`"ServiceName=${serviceName}`"" $fields += "`"PackageRepoPath=${pkgRepoPath}`"" if ($extraFields) { $fields += $extraFields } if ($existingItem) { $changedField = $null if ($lang -ne $existingItem.fields["Custom.Language"]) { $changedField = "Custom.Language" } if ($pkgName -ne $existingItem.fields["Custom.Package"]) { $changedField = "Custom.Package" } if ($pkgGroupId -ne $existingItem.fields["Custom.GroupId"]) { $changedField = "Custom.GroupId" } if ($verMajorMinor -ne $existingItem.fields["Custom.PackageVersionMajorMinor"]) { $changedField = "Custom.PackageVersionMajorMinor" } if ($pkgDisplayName -ne $existingItem.fields["Custom.PackageDisplayName"]) { $changedField = "Custom.PackageDisplayName" } if ($pkgType -ne [string]$existingItem.fields["Custom.PackageType"]) { $changedField = "Custom.PackageType" } if ($pkgNewLibrary -ne $existingItem.fields["Custom.PackageTypeNewLibrary"]) { $changedField = "Custom.PackageTypeNewLibrary" } if ($pkgRepoPath -ne $existingItem.fields["Custom.PackageRepoPath"]) { $changedField = "Custom.PackageRepoPath" } if ($serviceName -ne $existingItem.fields["Custom.ServiceName"]) { $changedField = "Custom.ServiceName" } if ($title -ne $existingItem.fields["System.Title"]) { $changedField = "System.Title" } if ($changedField) { Write-Host "At least field $changedField ($($existingItem.fields[$changedField])) changed so updating." } if ($changedField) { $beforeState = $existingItem.fields["System.State"] # Need to set to New to be able to update $existingItem = UpdateWorkItem -id $existingItem.id -fields $fields -title $title -state "New" -assignedTo $assignedTo -outputCommand $outputCommand Write-Host "[$($existingItem.id)]$lang - $pkgName($verMajorMinor) - Updated" if ($beforeState -ne $existingItem.fields['System.State']) { Write-Verbose "Resetting state for [$($existingItem.id)] from '$($existingItem.fields['System.State'])' to '$beforeState'" $existingItem = UpdateWorkItem $existingItem.id -state $beforeState -outputCommand $outputCommand } } $newparentItem = FindOrCreatePackageGroupParent $serviceName $pkgDisplayName -outputCommand $false -tag $tag -ignoreReleasePlannerTests $ignoreReleasePlannerTests UpdateWorkItemParent $existingItem $newParentItem -outputCommand $outputCommand return $existingItem } $parentItem = FindOrCreatePackageGroupParent $serviceName $pkgDisplayName -outputCommand $false -tag $tag -ignoreReleasePlannerTests $ignoreReleasePlannerTests Write-Host "Found product work item [$($parentItem.id)]. Creating package work item." $workItem = CreateWorkItem $title "Package" "Release" "Release" $fields $assignedTo $parentItem.id -outputCommand $outputCommand -relatedId $relatedId -tag $tag Write-Host "[$($workItem.id)]$lang - $pkgName($verMajorMinor) - Created" return $workItem } function FindOrCreatePackageGroupParent($serviceName, $packageDisplayName, $outputCommand = $true, $ignoreReleasePlannerTests = $true, $tag = $null) { $existingItem = FindParentWorkItem $serviceName $packageDisplayName -outputCommand $outputCommand -ignoreReleasePlannerTests $ignoreReleasePlannerTests -tag $tag if ($existingItem) { Write-Verbose "Found existing product work item [$($existingItem.id)]" $newparentItem = FindOrCreateServiceParent $serviceName -outputCommand $outputCommand -ignoreReleasePlannerTests $ignoreReleasePlannerTests -tag $tag UpdateWorkItemParent $existingItem $newParentItem return $existingItem } $fields = @() $fields += "`"PackageDisplayName=${packageDisplayName}`"" $fields += "`"ServiceName=${serviceName}`"" $fields += "`"Custom.EpicType=Product`"" $serviceParentItem = FindOrCreateServiceParent $serviceName -outputCommand $outputCommand -ignoreReleasePlannerTests $ignoreReleasePlannerTests -tag $tag $workItem = CreateWorkItem $packageDisplayName "Epic" "Release" "Release" $fields $null $serviceParentItem.id -tag $tag $localKey = BuildHashKey $serviceName $packageDisplayName Write-Host "[$($workItem.id)]$localKey - Created Parent" $parentWorkItems[$localKey] = $workItem return $workItem } function FindOrCreateServiceParent($serviceName, $outputCommand = $true, $ignoreReleasePlannerTests = $true, $tag = $null) { $serviceParent = FindParentWorkItem $serviceName -packageDisplayName $null -outputCommand $outputCommand -ignoreReleasePlannerTests $ignoreReleasePlannerTests -tag $tag if ($serviceParent) { Write-Verbose "Found existing service work item [$($serviceParent.id)]" return $serviceParent } $fields = @() $fields += "`"PackageDisplayName=`"" $fields += "`"ServiceName=${serviceName}`"" $fields += "`"Custom.EpicType=Service`"" $parentId = $null $workItem = CreateWorkItem $serviceName "Epic" "Release" "Release" $fields $null $parentId -outputCommand $outputCommand -tag $tag $localKey = BuildHashKey $serviceName Write-Host "[$($workItem.id)]$localKey - Created service work item" $parentWorkItems[$localKey] = $workItem return $workItem } function ParseVersionSetFromMDField([string]$field) { $MDTableRegex = "\|\s*(?\S*)\s*\|\s*(?\S*)\s*\|\s*(?\S*)\s*\|" $versionSet = @{} $tableMatches = [Regex]::Matches($field, $MDTableRegex) foreach ($match in $tableMatches) { if ($match.Groups["t"].Value -eq "Type" -or $match.Groups["t"].Value -eq "-") { continue } $version = New-Object PSObject -Property @{ Type = $match.Groups["t"].Value Version = $match.Groups["v"].Value Date = $match.Groups["d"].Value } if (!$versionSet.ContainsKey($version.Version)) { $versionSet[$version.Version] = $version } } return $versionSet } function GetTextVersionFields($versionList, $pkgWorkItem) { $betaVersions = $gaVersions = $patchVersions = "" foreach ($v in $versionList) { $vstr = "$($v.Version),$($v.Date)" if ($v.Type -eq "Beta") { if ($betaVersions.Length + $vstr.Length -lt 255) { if ($betaVersions.Length -gt 0) { $betaVersions += "|" } $betaVersions += $vstr } } elseif ($v.Type -eq "GA") { if ($gaVersions.Length + $vstr.Length -lt 255) { if ($gaVersions.Length -gt 0) { $gaVersions += "|" } $gaVersions += $vstr } } elseif ($v.Type -eq "Patch") { if ($patchVersions.Length + $vstr.Length -lt 255) { if ($patchVersions.Length -gt 0) { $patchVersions += "|" } $patchVersions += $vstr } } } $fieldUpdates = @() if ("$($pkgWorkItem.fields["Custom.PackageBetaVersions"])" -ne $betaVersions) { $fieldUpdates += @" { "op": "replace", "path": "/fields/PackageBetaVersions", "value": "$betaVersions" } "@ } if ("$($pkgWorkItem.fields["Custom.PackageGAVersion"])" -ne $gaVersions) { $fieldUpdates += @" { "op": "replace", "path": "/fields/PackageGAVersion", "value": "$gaVersions" } "@ } if ("$($pkgWorkItem.fields["Custom.PackagePatchVersions"])" -ne $patchVersions) { $fieldUpdates += @" { "op": "replace", "path": "/fields/PackagePatchVersions", "value": "$patchVersions" } "@ } return ,$fieldUpdates } function GetMDVersionValue($versionlist) { $mdVersions = "" $mdFormat = "| {0} | {1} | {2} |`n" $htmlVersions = "" $htmlFormat = @" {0} {1} {2} "@ foreach ($version in $versionList) { $mdVersions += ($mdFormat -f $version.Type, $version.Version, $version.Date) $htmlVersions += ($htmlFormat -f $version.Type, $version.Version, $version.Date) } $htmlTemplate = @"
htmlVersions
Type Version Date
"@ -replace "'", '\"' return $htmlTemplate.Replace("mdVersions", $mdVersions).Replace("htmlVersions", "`n$htmlVersions"); } function UpdatePackageVersions($pkgWorkItem, $plannedVersions, $shippedVersions) { # Create the planned and shipped versions, adding the new ones if any $updatePlanned = $false $plannedVersionSet = ParseVersionSetFromMDField $pkgWorkItem.fields["Custom.PlannedPackages"] foreach ($version in $plannedVersions) { if (!$plannedVersionSet.ContainsKey($version.Version)) { $plannedVersionSet[$version.Version] = $version $updatePlanned = $true } else { # Lets check to see if someone wanted to update a date $existingVersion = $plannedVersionSet[$version.Version] if ($existingVersion.Date -ne $version.Date) { $existingVersion.Date = $version.Date $updatePlanned = $true } } } $updateShipped = $false $shippedVersionSet = ParseVersionSetFromMDField $pkgWorkItem.fields["Custom.ShippedPackages"] foreach ($version in $shippedVersions) { if (!$shippedVersionSet.ContainsKey($version.Version)) { $shippedVersionSet[$version.Version] = $version $updateShipped = $true } else { # Check for any date update, general case would from be previous Unknown to date if ($shippedVersionSet[$version.Version].Date -ne $version.Date) { $shippedVersionSet[$version.Version] = $version $updateShipped = $true } } } $versionSet = @{} foreach ($version in $shippedVersionSet.Keys) { if (!$versionSet.ContainsKey($version)) { $versionSet[$version] = $shippedVersionSet[$version] } } foreach ($version in @($plannedVersionSet.Keys)) { if (!$versionSet.ContainsKey($version)) { $versionSet[$version] = $plannedVersionSet[$version] } else { # Looks like we shipped this version so remove it from the planned set $plannedVersionSet.Remove($version) $updatePlanned = $true } } $fieldUpdates = @() if ($updatePlanned) { $plannedPackages = GetMDVersionValue ($plannedVersionSet.Values | Sort-Object {$_.Date -as [DateTime]}, Version -Descending) $fieldUpdates += @" { "op": "replace", "path": "/fields/Planned Packages", "value": "$plannedPackages" } "@ } if ($updateShipped) { $newShippedVersions = $shippedVersionSet.Values | Sort-Object {$_.Date -as [DateTime]}, Version -Descending $shippedPackages = GetMDVersionValue $newShippedVersions $fieldUpdates += @" { "op": "replace", "path": "/fields/Shipped Packages", "value": "$shippedPackages" } "@ # If we shipped a version after we set "In Release" state then reset the state to "Next Release Unknown" if ($pkgWorkItem.fields["System.State"] -eq "In Release") { $lastShippedDate = $newShippedVersions[0].Date -as [DateTime] $markedInReleaseDate = ([DateTime]$pkgWorkItem.fields["Microsoft.VSTS.Common.StateChangeDate"]) # We just shipped so lets set the state to "Next Release Unknown" if ($lastShippedDate -and $markedInReleaseDate -le $lastShippedDate) { $fieldUpdates += @' { "op": "replace", "path": "/fields/State", "value": "Next Release Unknown" } '@ } } } # Full merged version set $versionList = $versionSet.Values | Sort-Object {$_.Date -as [DateTime]}, Version -Descending $versionFieldUpdates = GetTextVersionFields $versionList $pkgWorkItem if ($versionFieldUpdates.Count -gt 0) { $fieldUpdates += $versionFieldUpdates } # If no version files to update do nothing if ($fieldUpdates.Count -eq 0) { return $pkgWorkItem } $versionsForDebug = ($versionList | Foreach-Object { $_.Version }) -join "," $id = $pkgWorkItem.id $loggingString = "[$($pkgWorkItem.id)]" $loggingString += "$($pkgWorkItem.fields['Custom.Language'])" $loggingString += " - $($pkgWorkItem.fields['Custom.Package'])" $loggingString += "($($pkgWorkItem.fields['Custom.PackageVersionMajorMinor']))" $loggingString += " - Updating versions $versionsForDebug" Write-Host $loggingString $body = "[" + ($fieldUpdates -join ',') + "]" $response = Invoke-RestMethod -Method PATCH ` -Uri "https://dev.azure.com/azure-sdk/_apis/wit/workitems/${id}?api-version=6.0" ` -Headers (Get-DevOpsRestHeaders) -Body $body -ContentType "application/json-patch+json" | ConvertTo-Json -Depth 10 | ConvertFrom-Json -AsHashTable return $response } function UpdateValidationStatus($pkgvalidationDetails, $BuildDefinition, $PipelineUrl) { $pkgName = $pkgValidationDetails.Name $groupId = $pkgValidationDetails.GroupId $versionString = $pkgValidationDetails.Version $parsedNewVersion = [AzureEngSemanticVersion]::new($versionString) $versionMajorMinor = "" + $parsedNewVersion.Major + "." + $parsedNewVersion.Minor $workItem = FindPackageWorkItem -lang $LanguageDisplayName -packageName $pkgName -groupId $groupId -version $versionMajorMinor -includeClosed $true -outputCommand $false if (!$workItem) { Write-Host "No work item found for package [$pkgName] with groupId [$groupId]." return $false } $changeLogStatus = $pkgValidationDetails.ChangeLogValidation.Status $changeLogDetails = $pkgValidationDetails.ChangeLogValidation.Message $apiReviewStatus = $pkgValidationDetails.APIReviewValidation.Status $apiReviewDetails = $pkgValidationDetails.APIReviewValidation.Message $packageNameStatus = $pkgValidationDetails.PackageNameValidation.Status $packageNameDetails = $pkgValidationDetails.PackageNameValidation.Message $fields = @() $fields += "`"PackageVersion=${versionString}`"" $fields += "`"ChangeLogStatus=${changeLogStatus}`"" $fields += "`"ChangeLogValidationDetails=${changeLogDetails}`"" $fields += "`"APIReviewStatus=${apiReviewStatus}`"" $fields += "`"APIReviewStatusDetails=${apiReviewDetails}`"" $fields += "`"PackageNameApprovalStatus=${packageNameStatus}`"" $fields += "`"PackageNameApprovalDetails=${packageNameDetails}`"" if ($BuildDefinition) { $fields += "`"PipelineDefinition=$BuildDefinition`"" } if ($PipelineUrl) { $fields += "`"LatestPipelineRun=$PipelineUrl`"" } $workItem = UpdateWorkItem -id $workItem.id -fields $fields Write-Host "[$($workItem.id)]$LanguageDisplayName - $pkgName($versionMajorMinor) - Updated" return $true } function Get-LanguageDevOpsName($LanguageShort) { switch ($LanguageShort.ToLower()) { "net" { return "Dotnet" } "js" { return "JavaScript" } "java" { return "Java" } "go" { return "Go" } "python" { return "Python" } default { return $null } } } function Get-ReleasePlanForPackage($packageName) { $devopsFieldLanguage = Get-LanguageDevOpsName -LanguageShort $LanguageShort if (!$devopsFieldLanguage) { Write-Host "Unsupported language to check release plans, language [$LanguageShort]" return $null } $prStatusFieldName = "SDKPullRequestStatusFor$($devopsFieldLanguage)" $packageNameFieldName = "$($devopsFieldLanguage) Package Name" $fields = @() $fields += "System.ID" $fields += "System.State" $fields += "System.AssignedTo" $fields += "System.Parent" $fields += "System.Tags" $fieldList = ($fields | ForEach-Object { "[$_]"}) -join ", " $query = "SELECT ${fieldList} FROM WorkItems WHERE [Work Item Type] = 'Release Plan' AND [${packageNameFieldName}] = '${packageName}'" $query += " AND [${prStatusFieldName}] = 'merged'" $query += " AND [System.State] IN ('In Progress')" $query += " AND [System.Tags] NOT CONTAINS 'Release Planner App Test'" $workItems = Invoke-Query $fields $query return $workItems } function Update-ReleaseStatusInReleasePlan($releasePlanWorkItemId, $status, $version) { $devopsFieldLanguage = Get-LanguageDevOpsName -LanguageShort $LanguageShort if (!$devopsFieldLanguage) { Write-Host "Unsupported language to check release plans, language [$LanguageShort]" return $null } $fields = @() $fields += "`"ReleaseStatusFor$($devopsFieldLanguage)=$status`"" $fields += "`"ReleasedVersionFor$($devopsFieldLanguage)=$version`"" Write-Host "Updating Release Plan [$releasePlanWorkItemId] with status [$status] for language [$LanguageShort]." $workItem = UpdateWorkItem -id $releasePlanWorkItemId -fields $fields Write-Host "Updated release status for [$LanguageShort] in Release Plan [$releasePlanWorkItemId]" } function Update-PullRequestInReleasePlan($releasePlanWorkItemId, $pullRequestUrl, $status, $languageName) { $devopsFieldLanguage = Get-LanguageDevOpsName -LanguageShort $languageName if (!$devopsFieldLanguage) { Write-Host "Unsupported language to update release plan, language [$languageName]" return $null } $fields = @() if ($pullRequestUrl) { $fields += "`"SDKPullRequestFor$($devopsFieldLanguage)=$pullRequestUrl`"" } $fields += "`"SDKPullRequestStatusFor$($devopsFieldLanguage)=$status`"" Write-Host "Updating release plan [$releasePlanWorkItemId] with pull request details for language [$languageName]." $workItem = UpdateWorkItem -id $releasePlanWorkItemId -fields $fields Write-Host "Updated pull request details for [$languageName] in release plan [$releasePlanWorkItemId]" } function Get-ReleasePlan-Link($releasePlanWorkItemId) { $fields = @() $fields += "System.Id" $fields += "System.Title" $fields += "Custom.ReleasePlanLink" $fields += "Custom.ReleasePlanSubmittedby" $fieldList = ($fields | ForEach-Object { "[$_]"}) -join ", " $query = "SELECT ${fieldList} FROM WorkItems WHERE [System.Id] = $releasePlanWorkItemId" $workItem = Invoke-Query $fields $query if (!$workItem) { Write-Host "Release plan with ID $releasePlanWorkItemId not found." return $null } return $workItem["fields"] } function Get-ReleasePlansForCPEXAttestation() { $fields = @() $fields += "Custom.ProductServiceTreeID" $fields += "Custom.ReleasePlanType" $fields += "Custom.ProductType" $fields += "Custom.DataScope" $fields += "Custom.MgmtScope" $fields += "Custom.ProductName" $fieldList = ($fields | ForEach-Object { "[$_]"}) -join ", " $query = "SELECT ${fieldList} FROM WorkItems WHERE [System.WorkItemType] = 'Release Plan'" $query += " AND [System.State] = 'Finished'" $query += " AND [Custom.AttestationStatus] IN ('', 'Pending')" $query += " AND [System.Tags] NOT CONTAINS 'Release Planner App Test'" $query += " AND [System.Tags] NOT CONTAINS 'Release Planner Test App'" $query += " AND [System.Tags] NOT CONTAINS 'non-APEX tracking'" $query += " AND [System.Tags] NOT CONTAINS 'out of scope APEX'" $query += " AND [System.Tags] NOT CONTAINS 'APEX out of scope'" $query += " AND [System.Tags] NOT CONTAINS 'validate APEX out of scope'" $query += " AND [Custom.ProductServiceTreeID] <> ''" $query += " AND [Custom.ProductLifecycle] <> ''" $query += " AND [Custom.ProductType] IN ('Feature', 'Offering', 'Sku')" $workItems = Invoke-Query $fields $query return $workItems } function Get-TriagesForCPEXAttestation() { $fields = @() $fields += "Custom.ProductServiceTreeID" $fields += "Custom.ProductType" $fields += "Custom.ProductLifecycle" $fields += "Custom.DataScope" $fields += "Custom.MgmtScope" $fields += "Custom.DataplaneAttestationStatus" $fields += "Custom.ManagementPlaneAttestationStatus" $fields += "Custom.ProductName" $fieldList = ($fields | ForEach-Object { "[$_]"}) -join ", " $query = "SELECT ${fieldList} FROM WorkItems WHERE [System.WorkItemType] = 'Triage'" $query += " AND ([Custom.DataplaneAttestationStatus] IN ('', 'Pending') OR [Custom.ManagementPlaneAttestationStatus] IN ('', 'Pending'))" $query += " AND [System.Tags] NOT CONTAINS 'Release Planner App Test'" $query += " AND [System.Tags] NOT CONTAINS 'Release Planner Test App'" $query += " AND [System.Tags] NOT CONTAINS 'non-APEX tracking'" $query += " AND [System.Tags] NOT CONTAINS 'out of scope APEX'" $query += " AND [System.Tags] NOT CONTAINS 'APEX out of scope'" $query += " AND [System.Tags] NOT CONTAINS 'validate APEX out of scope'" $query += " AND [Custom.ProductServiceTreeID] <> ''" $query += " AND [Custom.ProductLifecycle] <> ''" $query += " AND [Custom.ProductType] IN ('Feature', 'Offering', 'Sku')" $workItems = Invoke-Query $fields $query return $workItems } function Update-AttestationStatusInWorkItem($workItemId, $fieldName, $status) { $dateFieldName = $fieldName -replace 'Status$', 'Date' $fields = @() $fields += "`"${fieldName}=${status}`"" $fields += "`"${dateFieldName}=$(Get-Date)`"" Write-Host "Updating Work Item [$workItemId] with status [$status] for field [$fieldName]." $workItem = UpdateWorkItem -id $workItemId -fields $fields Write-Host "Updated attestation status for [$fieldName] in Work Item [$workItemId]" return $true } # This function was originally the entirety of what was in Update-DevOps-Release-WorkItem.ps1 # and has been converted to a function. function Update-DevOpsReleaseWorkItem { param( [Parameter(Mandatory=$true)] [string]$language, [Parameter(Mandatory=$true)] [string]$packageName, [Parameter(Mandatory=$true)] [string]$version, [string]$plannedDate, [string]$groupId = $null, [string]$serviceName = $null, [string]$packageDisplayName = $null, [string]$packageRepoPath = "NA", [string]$packageType = "client", [string]$packageNewLibrary = "true", [string]$relatedWorkItemId = $null, [string]$tag = $null, [bool]$inRelease = $true, [string]$specProjectPath = "" ) if (!(Get-Command az -ErrorAction SilentlyContinue)) { Write-Error 'You must have the Azure CLI installed: https://aka.ms/azure-cli' return $false } CheckAzLoginAndDevOpsExtensionInstall CheckDevOpsAccess $parsedNewVersion = [AzureEngSemanticVersion]::new($version) $state = "In Release" $releaseType = $parsedNewVersion.VersionType $versionMajorMinor = "" + $parsedNewVersion.Major + "." + $parsedNewVersion.Minor $packageInfo = [PSCustomObject][ordered]@{ Package = $packageName GroupId = $groupId DisplayName = $packageDisplayName ServiceName = $serviceName RepoPath = $packageRepoPath Type = $packageType New = $packageNewLibrary SpecProjectPath = $specProjectPath }; if (!$plannedDate) { $plannedDate = Get-Date -Format "MM/dd/yyyy" } $plannedVersions = @( [PSCustomObject][ordered]@{ Type = $releaseType Version = $version Date = $plannedDate } ) $ignoreReleasePlannerTests = $true if ($tag -and $tag.Contains("Release Planner App Test")) { $ignoreReleasePlannerTests = $false } $workItem = FindOrCreateClonePackageWorkItem $language $packageInfo $versionMajorMinor -allowPrompt $true -outputCommand $false -relatedId $relatedWorkItemId -tag $tag -ignoreReleasePlannerTests $ignoreReleasePlannerTests if (!$workItem) { Write-Host "Something failed as we don't have a work-item so exiting." return $false } Write-Host "Updated or created a release work item for a package release with the following properties:" Write-Host " Language: $($workItem.fields['Custom.Language'])" Write-Host " Version: $($workItem.fields['Custom.PackageVersionMajorMinor'])" Write-Host " Package: $($workItem.fields['Custom.Package'])" if ($workItem.fields['System.AssignedTo']) { Write-Host " AssignedTo: $($workItem.fields['System.AssignedTo']["uniqueName"])" } else { Write-Host " AssignedTo: unassigned" } Write-Host " PackageDisplayName: $($workItem.fields['Custom.PackageDisplayName'])" Write-Host " ServiceName: $($workItem.fields['Custom.ServiceName'])" Write-Host " PackageType: $($workItem.fields['Custom.PackageType'])" Write-Host "" if ($inRelease) { Write-Host "Marking item [$($workItem.id)]$($workItem.fields['System.Title']) as '$state' for '$releaseType'" $updatedWI = UpdatePackageWorkItemReleaseState -id $workItem.id -state "In Release" -releaseType $releaseType -outputCommand $false } $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 } Write-Host "Release tracking item is at https://dev.azure.com/azure-sdk/Release/_workitems/edit/$($updatedWI.id)/" return $true }