Tools to generate migration guide. (#13334)

Co-authored-by: wyunchi-ms <[email protected]>

Author: wyunchi-ms

tools/BreakingChanges/GenerateMigrationExcel.ps1

@@ -0,0 +1,48 @@
+#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"
+}
+
+$Data = New-Object System.Collections.ArrayList
+foreach ($ModuleName in $TotalTable.Keys) {
+    foreach ($CmdletName in $TotalTable[$ModuleName].Keys) {
+        $Tmp = New-Object -TypeName PSObject -Property @{
+            ModuleName = $ModuleName
+            CmdletName = $CmdletName
+            Description = $TotalTable[$ModuleName][$CmdletName]
+            Before = $Null
+            After = $Null
+            TeamMember = $Null
+            PR = $Null
+        } | Select ModuleName, CmdletName, Description, Before, After, TeamMember, PR
+        $Null = $Data.Add($Tmp)
+    }
+}
+$Data | Export-XLSX -Path $ExcelPath
+Write-Host "Excel is generated at $ExcelPath. Please goto edit it."

tools/BreakingChanges/GenerateMigrationGuide.ps1

@@ -0,0 +1,38 @@
+#Requires -Modules PSExcel
+[CmdletBinding()]
+Param(
+    [Parameter()]
+    [string]$ExcelPath,
+    [Parameter()]
+    [string]$TargetAzVersion
+)
+
+$BreakingChangeItems = Import-XLSX -Path $ExcelPath -RowStart 1
+$TotalTable = @{}
+foreach ($BreakingChangeItem in $BreakingChangeItems) {
+    $ModuleName = $BreakingChangeItem.ModuleName
+    if (-not $TotalTable.ContainsKey($ModuleName)) {
+        $Tmp = New-Object System.Collections.ArrayList
+        $TotalTable.Add($ModuleName, $Tmp)
+    }
+    $Null = $TotalTable[$ModuleName].Add($BreakingChangeItem)
+}
+
+$MigrationGuidePath = [System.IO.Path]::Combine($PSScriptRoot, '..', '..', 'documentation', 'migration-guides', "Az.$TargetAzVersion.0-migration-guide.md")
+$MigrationGuidePath = Resolve-Path -Path $MigrationGuidePath
+Set-Content -Path $MigrationGuidePath -Value "# Migration Guide for Az $TargetAzVersion.0`n"
+
+foreach ($Module in $TotalTable.Keys) {
+    Add-Content -Path $MigrationGuidePath -Value "## $Module`n"
+    foreach ($BreakingChangeItem in $TotalTable[$Module]) {
+        $CmdletName = $BreakingChangeItem.CmdletName
+        $Description = $BreakingChangeItem.Description
+        $Before = $BreakingChangeItem.Before
+        $After = $BreakingChangeItem.After
+        Add-Content -Path $MigrationGuidePath -Value "### ``${CmdletName}```n${Description}`n"
+        if ($Null -ne $Before) {
+            Add-Content -Path $MigrationGuidePath -Value "#### Before`n${Before}`n#### After`n${After}`n`n"
+        }
+    }
+}
+Write-Host "Migration guide is generated at: $MigrationGuidePath"