From 3711162ea6196bc7a022c550e049be3f5d535dc2 Mon Sep 17 00:00:00 2001 From: Yunchi Wang <54880216+wyunchi-ms@users.noreply.github.com> Date: Tue, 9 Jan 2024 15:24:17 +0800 Subject: [PATCH 1/2] Add tools to refresh documentation\azure-powershell-modules.md --- tools/ResolveTools/Resolve-ModulesDoc.ps1 | 69 +++++++++++++++++++ .../Resolve-SolutionFile.ps1 | 4 +- 2 files changed, 71 insertions(+), 2 deletions(-) create mode 100644 tools/ResolveTools/Resolve-ModulesDoc.ps1 rename tools/{ => ResolveTools}/Resolve-SolutionFile.ps1 (97%) diff --git a/tools/ResolveTools/Resolve-ModulesDoc.ps1 b/tools/ResolveTools/Resolve-ModulesDoc.ps1 new file mode 100644 index 000000000000..a9a9434d4a3f --- /dev/null +++ b/tools/ResolveTools/Resolve-ModulesDoc.ps1 @@ -0,0 +1,69 @@ +$Modules = Get-ChildItem -Recurse -Depth 2 -Path src -File -Filter *.sln | ForEach-Object {$_.BaseName} + +$Content = @" +# Azure PowerShell Modules + +## Rollup Module + +| Description | Module Name | PowerShell Gallery Link | +| ------------------------------------- | ----------- | -------------------------------- | +| Azure PowerShell | ``Az`` | [![Az]][AzGallery] | +| Azure PowerShell with preview modules | ``AzPreview`` | [![AzPreview]][AzPreviewGallery] | + +## Service Modules + +| Azure Service | Module Name | PowerShell Gallery Link | Changelog | +| ------------------------------ | ------------------------------- | ------------------------------------------------------------------ | -------------------------------------------------- | + +"@ + +foreach ($module in $Modules) +{ + $serviceName = $module + $moduleName = "``Az.$module``" + $PSGalleryLink = "[![$module]][${module}Gallery]" + $changeLogLink = "[Changelog][${module}ChangeLog]" + $content += "| {0, -30} | {1, -31} | {2, -66} | {3, -48} |`n" -f $serviceName, $moduleName, $PSGalleryLink, $changeLogLink +} + +$content += @" + + + + +[Az]: https://img.shields.io/powershellgallery/v/Az.svg?style=flat-square&label=Az +[AzPreview]: https://img.shields.io/powershellgallery/v/AzPreview.svg?style=flat-square&label=AzPreview + +"@ + +foreach ($module in $Modules) +{ + $ShieldsLink = "[${module}]:" + $content += "{0, -29} https://img.shields.io/powershellgallery/v/Az.$Module.svg?style=flat-square&label=Az.$Module`n" -f $ShieldsLink +} + +$content += @" + + +[AzGallery]: https://www.powershellgallery.com/packages/Az/ +[AzPreviewGallery]: https://www.powershellgallery.com/packages/AzPreview/ + +"@ + +foreach ($module in $Modules) +{ + $PSGalleryLink = "[${module}Gallery]:" + $content += "{0, -36} https://www.powershellgallery.com/packages/Az.$Module/`n" -f $PSGalleryLink +} +$content += @" + + + +"@ +foreach ($module in $Modules) +{ + $ChangeLogLink = "[${Module}ChangeLog]:" + $content += "{0, -38} ../src/$Module/$Module/ChangeLog.md`n" -f $ChangeLogLink +} + +$content | Out-File -FilePath .\documentation\azure-powershell-modules.md -Encoding utf8 \ No newline at end of file diff --git a/tools/Resolve-SolutionFile.ps1 b/tools/ResolveTools/Resolve-SolutionFile.ps1 similarity index 97% rename from tools/Resolve-SolutionFile.ps1 rename to tools/ResolveTools/Resolve-SolutionFile.ps1 index 2e231d660147..1f6f63fa77af 100644 --- a/tools/Resolve-SolutionFile.ps1 +++ b/tools/ResolveTools/Resolve-SolutionFile.ps1 @@ -14,7 +14,7 @@ # This will resolve all the solution files under the src folder # ```powershell -# ./tools/Resolve-SolutionFile.ps1 +# ./tools/ResolveTools/Resolve-SolutionFile.ps1 # ``` function Resolve($solutionFilePath) { @@ -84,5 +84,5 @@ function Resolve($solutionFilePath) { Set-Location $saveLocation } -$srcFolder = "$PSScriptRoot/../src" +$srcFolder = "$PSScriptRoot/../../src" Get-ChildItem -Recurse -Filter *.sln -Path $srcFolder -Exclude Accounts.sln -Depth 2 | Foreach-Object { Resolve $_.FullName } \ No newline at end of file From f3fb53c4f5bcd381fd4aec11819e2647b3ec6228 Mon Sep 17 00:00:00 2001 From: Yunchi Wang <54880216+wyunchi-ms@users.noreply.github.com> Date: Tue, 9 Jan 2024 15:37:54 +0800 Subject: [PATCH 2/2] Add tools to refresh documentation\azure-powershell-modules.md --- tools/ResolveTools/Resolve-ModulesDoc.ps1 | 49 +++++++++++++---------- 1 file changed, 27 insertions(+), 22 deletions(-) diff --git a/tools/ResolveTools/Resolve-ModulesDoc.ps1 b/tools/ResolveTools/Resolve-ModulesDoc.ps1 index a9a9434d4a3f..46d623ecc95d 100644 --- a/tools/ResolveTools/Resolve-ModulesDoc.ps1 +++ b/tools/ResolveTools/Resolve-ModulesDoc.ps1 @@ -1,4 +1,6 @@ -$Modules = Get-ChildItem -Recurse -Depth 2 -Path src -File -Filter *.sln | ForEach-Object {$_.BaseName} +$ProjectRoot = "$PSScriptRoot/../.." + +$Modules = Get-ChildItem -Recurse -Depth 2 -Path "$ProjectRoot/src" -File -Filter *.sln | ForEach-Object {$_.BaseName} $Content = @" # Azure PowerShell Modules @@ -8,7 +10,7 @@ $Content = @" | Description | Module Name | PowerShell Gallery Link | | ------------------------------------- | ----------- | -------------------------------- | | Azure PowerShell | ``Az`` | [![Az]][AzGallery] | -| Azure PowerShell with preview modules | ``AzPreview`` | [![AzPreview]][AzPreviewGallery] | +| Azure PowerShell with preview Modules | ``AzPreview`` | [![AzPreview]][AzPreviewGallery] | ## Service Modules @@ -17,16 +19,18 @@ $Content = @" "@ -foreach ($module in $Modules) +# Table +foreach ($Module in $Modules) { - $serviceName = $module - $moduleName = "``Az.$module``" - $PSGalleryLink = "[![$module]][${module}Gallery]" - $changeLogLink = "[Changelog][${module}ChangeLog]" - $content += "| {0, -30} | {1, -31} | {2, -66} | {3, -48} |`n" -f $serviceName, $moduleName, $PSGalleryLink, $changeLogLink + $ServiceName = $Module + $ModuleName = "``Az.$Module``" + $PSGalleryLink = "[![$Module]][${Module}Gallery]" + $ChangeLogLink = "[Changelog][${Module}ChangeLog]" + $Content += "| {0,-30} | {1,-31} | {2,-66} | {3,-48} |`n" -f $ServiceName, $ModuleName, $PSGalleryLink, $ChangeLogLink } -$content += @" +# Shields +$Content += @" @@ -35,35 +39,36 @@ $content += @" [AzPreview]: https://img.shields.io/powershellgallery/v/AzPreview.svg?style=flat-square&label=AzPreview "@ - -foreach ($module in $Modules) +foreach ($Module in $Modules) { - $ShieldsLink = "[${module}]:" - $content += "{0, -29} https://img.shields.io/powershellgallery/v/Az.$Module.svg?style=flat-square&label=Az.$Module`n" -f $ShieldsLink + $ShieldsLink = "[${Module}]:" + $Content += "{0,-29} https://img.shields.io/powershellgallery/v/Az.$Module.svg?style=flat-square&label=Az.$Module`n" -f $ShieldsLink } -$content += @" +# PowerShell Gallery +$Content += @" [AzGallery]: https://www.powershellgallery.com/packages/Az/ [AzPreviewGallery]: https://www.powershellgallery.com/packages/AzPreview/ "@ - -foreach ($module in $Modules) +foreach ($Module in $Modules) { - $PSGalleryLink = "[${module}Gallery]:" - $content += "{0, -36} https://www.powershellgallery.com/packages/Az.$Module/`n" -f $PSGalleryLink + $PSGalleryLink = "[${Module}Gallery]:" + $Content += "{0,-36} https://www.powershellgallery.com/packages/Az.$Module/`n" -f $PSGalleryLink } -$content += @" + +# ChangeLog +$Content += @" "@ -foreach ($module in $Modules) +foreach ($Module in $Modules) { $ChangeLogLink = "[${Module}ChangeLog]:" - $content += "{0, -38} ../src/$Module/$Module/ChangeLog.md`n" -f $ChangeLogLink + $Content += "{0,-38} ../src/$Module/$Module/ChangeLog.md`n" -f $ChangeLogLink } -$content | Out-File -FilePath .\documentation\azure-powershell-modules.md -Encoding utf8 \ No newline at end of file +$Content | Out-File -FilePath "$ProjectRoot/documentation/azure-powershell-Modules.md" -Encoding utf8 \ No newline at end of file