Sync tools folder from main branch to generation branch (#24736)

Co-authored-by: azurepowershell <[email protected]>

Author: azure-powershell-bot

.azure-pipelines/live-test.yml

@@ -180,37 +180,37 @@ stages:
       psVersion: ${{ parameters.ps_latest }}
       dotnetVersion: ${{ parameters.dotnet_sdk_8 }}
 
-  - template: util/live-test-steps.yml
-    parameters:
-      name: 'ps_7_2_x_macOS'
-      vmImage: ${{ parameters.os_macos }}
-      osType: 'MacOS'
-      psVersion: ${{ parameters.ps_7_2_x }}
-      dotnetVersion: ${{ parameters.dotnet_sdk_6 }}
-
-  - template: util/live-test-steps.yml
-    parameters:
-      name: 'ps_7_3_x_macOS'
-      vmImage: ${{ parameters.os_macos }}
-      osType: 'MacOS'
-      psVersion: ${{ parameters.ps_7_3_x }}
-      dotnetVersion: ${{ parameters.dotnet_sdk_7 }}
-
-  - template: util/live-test-steps.yml
-    parameters:
-      name: 'ps_7_4_x_macOS'
-      vmImage: ${{ parameters.os_macos }}
-      osType: 'MacOS'
-      psVersion: ${{ parameters.ps_7_4_x }}
-      dotnetVersion: ${{ parameters.dotnet_sdk_8 }}
-
-  - template: util/live-test-steps.yml
-    parameters:
-      name: 'ps_latest_macOS'
-      vmImage: ${{ parameters.os_macos }}
-      osType: 'MacOS'
-      psVersion: ${{ parameters.ps_latest }}
-      dotnetVersion: ${{ parameters.dotnet_sdk_8 }}
+  # - template: util/live-test-steps.yml
+  #   parameters:
+  #     name: 'ps_7_2_x_macOS'
+  #     vmImage: ${{ parameters.os_macos }}
+  #     osType: 'MacOS'
+  #     psVersion: ${{ parameters.ps_7_2_x }}
+  #     dotnetVersion: ${{ parameters.dotnet_sdk_6 }}
+
+  # - template: util/live-test-steps.yml
+  #   parameters:
+  #     name: 'ps_7_3_x_macOS'
+  #     vmImage: ${{ parameters.os_macos }}
+  #     osType: 'MacOS'
+  #     psVersion: ${{ parameters.ps_7_3_x }}
+  #     dotnetVersion: ${{ parameters.dotnet_sdk_7 }}
+
+  # - template: util/live-test-steps.yml
+  #   parameters:
+  #     name: 'ps_7_4_x_macOS'
+  #     vmImage: ${{ parameters.os_macos }}
+  #     osType: 'MacOS'
+  #     psVersion: ${{ parameters.ps_7_4_x }}
+  #     dotnetVersion: ${{ parameters.dotnet_sdk_8 }}
+
+  # - template: util/live-test-steps.yml
+  #   parameters:
+  #     name: 'ps_latest_macOS'
+  #     vmImage: ${{ parameters.os_macos }}
+  #     osType: 'MacOS'
+  #     psVersion: ${{ parameters.ps_latest }}
+  #     dotnetVersion: ${{ parameters.dotnet_sdk_8 }}
 
 - stage: Report
   displayName: Send Report

.azure-pipelines/release-test.yml

@@ -136,42 +136,42 @@ jobs:
     psVersion: ${{ parameters.preview_ps }}
     netCoreVersion: ${{ parameters.netCoreVersion_8 }}
 
-- template: util/smoke-test-steps.yml
-  parameters:
-    name: 'MacOS_PS7_2_X_SmokeTest'
-    agentPoolName: ${{ variables.macOsAgentPoolName }}
-    agentPoolVMImage: ${{ variables.macOsAgentPoolVMImage }}
-    psVersion: ${{ parameters.ps7_2 }}
-    netCoreVersion: ${{ parameters.netCoreVersion }}
-
-- template: util/smoke-test-steps.yml
-  parameters:
-    name: 'MacOS_PS7_3_X_SmokeTest'
-    agentPoolName: ${{ variables.macOsAgentPoolName }}
-    agentPoolVMImage: ${{ variables.macOsAgentPoolVMImage }}
-    psVersion: ${{ parameters.ps7_3 }}
-    netCoreVersion: ${{ parameters.netCoreVersion_7 }}
-
-- template: util/smoke-test-steps.yml
-  parameters:
-    name: 'MacOS_PS7_4_X_SmokeTest'
-    agentPoolName: ${{ variables.macOsAgentPoolName }}
-    agentPoolVMImage: ${{ variables.macOsAgentPoolVMImage }}
-    psVersion: ${{ parameters.ps7_4 }}
-    netCoreVersion: ${{ parameters.netCoreVersion_8 }}
-
-- template: util/smoke-test-steps.yml
-  parameters:
-    name: 'MacOS_Latest_PS_SmokeTest'
-    agentPoolName: ${{ variables.macOsAgentPoolName }}
-    agentPoolVMImage: ${{ variables.macOsAgentPoolVMImage }}
-    psVersion: ${{ parameters.latest_ps }}
-    netCoreVersion: ${{ parameters.netCoreVersion_8 }}
-
-- template: util/smoke-test-steps.yml
-  parameters:
-    name: 'MacOS_Preview_PS_SmokeTest'
-    agentPoolName: ${{ variables.macOsAgentPoolName }}
-    agentPoolVMImage: ${{ variables.macOsAgentPoolVMImage }}
-    psVersion: ${{ parameters.preview_ps }}
-    netCoreVersion: ${{ parameters.netCoreVersion_8 }}
+# - template: util/smoke-test-steps.yml
+#   parameters:
+#     name: 'MacOS_PS7_2_X_SmokeTest'
+#     agentPoolName: ${{ variables.macOsAgentPoolName }}
+#     agentPoolVMImage: ${{ variables.macOsAgentPoolVMImage }}
+#     psVersion: ${{ parameters.ps7_2 }}
+#     netCoreVersion: ${{ parameters.netCoreVersion }}
+
+# - template: util/smoke-test-steps.yml
+#   parameters:
+#     name: 'MacOS_PS7_3_X_SmokeTest'
+#     agentPoolName: ${{ variables.macOsAgentPoolName }}
+#     agentPoolVMImage: ${{ variables.macOsAgentPoolVMImage }}
+#     psVersion: ${{ parameters.ps7_3 }}
+#     netCoreVersion: ${{ parameters.netCoreVersion_7 }}
+
+# - template: util/smoke-test-steps.yml
+#   parameters:
+#     name: 'MacOS_PS7_4_X_SmokeTest'
+#     agentPoolName: ${{ variables.macOsAgentPoolName }}
+#     agentPoolVMImage: ${{ variables.macOsAgentPoolVMImage }}
+#     psVersion: ${{ parameters.ps7_4 }}
+#     netCoreVersion: ${{ parameters.netCoreVersion_8 }}
+
+# - template: util/smoke-test-steps.yml
+#   parameters:
+#     name: 'MacOS_Latest_PS_SmokeTest'
+#     agentPoolName: ${{ variables.macOsAgentPoolName }}
+#     agentPoolVMImage: ${{ variables.macOsAgentPoolVMImage }}
+#     psVersion: ${{ parameters.latest_ps }}
+#     netCoreVersion: ${{ parameters.netCoreVersion_8 }}
+
+# - template: util/smoke-test-steps.yml
+#   parameters:
+#     name: 'MacOS_Preview_PS_SmokeTest'
+#     agentPoolName: ${{ variables.macOsAgentPoolName }}
+#     agentPoolVMImage: ${{ variables.macOsAgentPoolVMImage }}
+#     psVersion: ${{ parameters.preview_ps }}
+#     netCoreVersion: ${{ parameters.netCoreVersion_8 }}

.github/PULL_REQUEST_TEMPLATE.md

@@ -6,12 +6,12 @@
 
 ## Mandatory Checklist
 
-- Please choose the target release of Azure PowerShell
+- Please choose the target release of Azure PowerShell. (⚠️**Target release** is a different concept from **API readiness**. Please click below links for details.)
   - [ ] [General release](../blob/main/CONTRIBUTING.md#target-release-types)
   - [ ] [Public preview](../blob/main/CONTRIBUTING.md#target-release-types)
   - [ ] [Private preview](../blob/main/CONTRIBUTING.md#target-release-types)
   - [ ] [Engineering build](../blob/main/CONTRIBUTING.md#target-release-types)
-  - [ ] N/A
+  - [ ] No need for a release
 
 - [ ] Check this box to confirm: **I have read the [_Submitting Changes_](../blob/main/CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](../blob/main/CONTRIBUTING.md) and reviewed the following information:**
 

tools/BreakingChanges/GenerateMigrationExcel.ps1

@@ -12,51 +12,55 @@
 # limitations under the License.
 # ----------------------------------------------------------------------------------
 
+# The generated excel will contains one sheet. The title is:
+# ModuleName, CmdletName, Description, Before, After, TeamMember, PR
+
+# .\tools\BreakingChanges\GenerateMigrationExcel.ps1 -ExcelPath (Join-Path $env:USERPROFILE "Documents" "2024-05-21-Az-12.0-Breaking-Change-Migration-Guide.xlsx")
+
 #Requires -Modules PSExcel
 [CmdletBinding()]
 Param(
     [Parameter()]
     [string]$ExcelPath
 )
-$ExcelPath = Resolve-Path -Path $ExcelPath
 If (Test-Path $ExcelPath) {
     Remove-Item $ExcelPath
 }
 $Path = [System.IO.Path]::Combine($PSScriptRoot, '..', '..')
 Set-Location -Path $Path
-Get-ChildItem -Path .\tools\StaticAnalysis\Exceptions\ -Filter BreakingChangeIssues.csv -Recurse
-dotnet msbuild /t:Clean
-dotnet msbuild /t:Build
-dotnet msbuild /t:StaticAnalysis
-$BreakingChangeItems = Import-Csv .\artifacts\StaticAnalysisResults\BreakingChangeIssues.csv
-$TotalTable = @{}
-foreach ($BreakingChangeItem in $BreakingChangeItems) {
-    $ModuleName = 'Az' + $BreakingChangeItem.AssemblyFileName.Replace("Microsoft.Azure.PowerShell.Cmdlets", "").Replace('.dll', '')
-    $CmdletName = $BreakingChangeItem.Target
-    $Description = $BreakingChangeItem.Description
-    if (-not $TotalTable.ContainsKey($ModuleName)) {
-        $TotalTable.Add($ModuleName, @{})
-    }
-    if (-not $TotalTable[$ModuleName].ContainsKey($CmdletName)) {
-        $TotalTable[$ModuleName].Add($CmdletName, "")
-    }
-    $TotalTable[$ModuleName][$CmdletName] = $TotalTable[$ModuleName][$CmdletName] + "$Description`n"
-}
+# dotnet msbuild /t:Clean
+# dotnet msbuild /t:Build
+# dotnet msbuild /t:StaticAnalysis
 
+Import-Module (Join-Path $PSScriptRoot "Get-BreakingChangeMetadata.ps1") -Force
+$ArtifactsPath = [System.IO.Path]::Combine($Path, "artifacts", "Debug")
+
+$AllModuleList = Get-ChildItem -Path $ArtifactsPath -Filter Az.* | ForEach-Object { $_.Name }
 $Data = New-Object System.Collections.ArrayList
-foreach ($ModuleName in $TotalTable.Keys) {
-    foreach ($CmdletName in $TotalTable[$ModuleName].Keys) {
-        $Tmp = New-Object -TypeName PSObject -Property @{
+ForEach ($ModuleName In $AllModuleList)
+{
+    Write-Host "Processing Module: $ModuleName"
+    $ModuleBreakingChangeInfo = Get-BreakingChangeMetadata -ArtifactsPath $ArtifactsPath -ModuleName $ModuleName
+    If ($ModuleBreakingChangeInfo.Count -eq 0)
+    {
+        Continue
+    }
+
+    ForEach ($CmdletName In ($ModuleBreakingChangeInfo.Keys | Sort-Object))
+    {
+        Write-Host "Processing Cmdlet: $ModuleName - $CmdletName"
+        $NewRow = New-Object -TypeName PSObject -Property @{
             ModuleName = $ModuleName
             CmdletName = $CmdletName
-            Description = $TotalTable[$ModuleName][$CmdletName]
+            Description = Export-BreakingChangeMessageOfCmdlet $ModuleBreakingChangeInfo[$CmdletName]
             Before = $Null
             After = $Null
             TeamMember = $Null
             PR = $Null
-        } | Select ModuleName, CmdletName, Description, Before, After, TeamMember, PR
-        $Null = $Data.Add($Tmp)
+        } | Select-Object ModuleName, CmdletName, Description, Before, After, TeamMember, PR
+        $Null = $Data.Add($NewRow)
     }
 }
+
 $Data | Export-XLSX -Path $ExcelPath
 Write-Host "Excel is generated at $ExcelPath. Please goto edit it."