🩹 [Patch]: Replace LogGroup with Set-GitHubLogGroup for consistent logging in build scripts

Author: MariusStorhaug

scripts/helpers/Build-PSModule.ps1

@@ -30,7 +30,7 @@
         [string] $ModuleOutputFolderPath
     )
 
-    LogGroup "Building module [$ModuleName]" {
+    Set-GitHubLogGroup "Building module [$ModuleName]" {
         $moduleSourceFolder = Get-Item -Path $ModuleSourceFolderPath
         $moduleOutputFolder = New-Item -Path $ModuleOutputFolderPath -Name $ModuleName -ItemType Directory -Force
         [pscustomobject]@{
@@ -44,7 +44,7 @@
     Build-PSModuleRootModule -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder
     Update-PSModuleManifestAliasesToExport -ModuleName $ModuleName -ModuleSourceFolder $moduleSourceFolder -ModuleOutputFolder $moduleOutputFolder
 
-    LogGroup 'Build manifest file - Final Result' {
+    Set-GitHubLogGroup 'Build manifest file - Final Result' {
         $outputManifestPath = Join-Path -Path $ModuleOutputFolder -ChildPath "$ModuleName.psd1"
         Show-FileContent -Path $outputManifestPath
     }

scripts/helpers/Build/Build-PSModuleBase.ps1

@@ -33,15 +33,15 @@
         [System.IO.DirectoryInfo] $ModuleOutputFolder
     )
 
-    LogGroup 'Build base' {
+    Set-GitHubLogGroup 'Build base' {
         $relModuleSourceFolder = $ModuleSourceFolder | Resolve-Path -Relative
         $relModuleOutputFolder = $ModuleOutputFolder | Resolve-Path -Relative
         Write-Host "Copying files from [$relModuleSourceFolder] to [$relModuleOutputFolder]"
         Copy-Item -Path "$ModuleSourceFolder\*" -Destination $ModuleOutputFolder -Recurse -Force -Exclude "$ModuleName.psm1"
         $null = New-Item -Path $ModuleOutputFolder -Name "$ModuleName.psm1" -ItemType File -Force
     }
 
-    LogGroup 'Build base - Result' {
+    Set-GitHubLogGroup 'Build base - Result' {
         Get-ChildItem -Path $ModuleOutputFolder -Recurse -Force | Resolve-Path -Relative | Sort-Object
     }
 }

scripts/helpers/Build/Build-PSModuleManifest.ps1

@@ -33,7 +33,7 @@
         [System.IO.DirectoryInfo] $ModuleOutputFolder
     )
 
-    LogGroup 'Build manifest file' {
+    Set-GitHubLogGroup 'Build manifest file' {
         $sourceManifestFilePath = Join-Path -Path $ModuleOutputFolder -ChildPath "$ModuleName.psd1"
         Write-Host "[SourceManifestFilePath] - [$sourceManifestFilePath]"
         if (-not (Test-Path -Path $sourceManifestFilePath)) {
@@ -442,23 +442,23 @@
         New-ModuleManifest -Path $outputManifestPath @manifest
     }
 
-    LogGroup 'Build manifest file - Result - Before format' {
+    Set-GitHubLogGroup 'Build manifest file - Result - Before format' {
         Show-FileContent -Path $outputManifestPath
     }
 
-    LogGroup 'Build manifest file - Format' {
+    Set-GitHubLogGroup 'Build manifest file - Format' {
         Set-ModuleManifest -Path $outputManifestPath
     }
 
-    LogGroup 'Build manifest file - Result - After format' {
+    Set-GitHubLogGroup 'Build manifest file - Result - After format' {
         Show-FileContent -Path $outputManifestPath
     }
 
-    LogGroup 'Build manifest file - Validate - Install module dependencies' {
+    Set-GitHubLogGroup 'Build manifest file - Validate - Install module dependencies' {
         Resolve-PSModuleDependency -ManifestFilePath $outputManifestPath
     }
 
-    LogGroup 'Build manifest file - Validate - Test manifest file' {
+    Set-GitHubLogGroup 'Build manifest file - Validate - Test manifest file' {
         Test-ModuleManifest -Path $outputManifestPath | Format-List | Out-String
     }
 }

scripts/helpers/Build/Build-PSModuleRootModule.ps1

@@ -51,7 +51,7 @@
     # Get the path separator for the current OS
     $pathSeparator = [System.IO.Path]::DirectorySeparatorChar
 
-    LogGroup 'Build root module' {
+    Set-GitHubLogGroup 'Build root module' {
         $rootModuleFile = New-Item -Path $ModuleOutputFolder -Name "$ModuleName.psm1" -Force
 
         #region - Analyze source files
@@ -254,26 +254,26 @@ Export-ModuleMember @exports
 
     }
 
-    LogGroup 'Build root module - Result - Before format' {
+    Set-GitHubLogGroup 'Build root module - Result - Before format' {
         Write-Host (Show-FileContent -Path $rootModuleFile)
     }
 
-    LogGroup 'Build root module - Format' {
+    Set-GitHubLogGroup 'Build root module - Format' {
         $AllContent = Get-Content -Path $rootModuleFile -Raw
         $settings = Join-Path -Path $PSScriptRoot 'PSScriptAnalyzer.Tests.psd1'
         Invoke-Formatter -ScriptDefinition $AllContent -Settings $settings |
             Out-File -FilePath $rootModuleFile -Encoding utf8BOM -Force
     }
 
-    LogGroup 'Build root module - Result - After format' {
+    Set-GitHubLogGroup 'Build root module - Result - After format' {
         Write-Host (Show-FileContent -Path $rootModuleFile)
     }
 
-    # LogGroup 'Build root module - Validate - Import' {
+    # Set-GitHubLogGroup 'Build root module - Validate - Import' {
     #     Install-PSModule -Path $ModuleOutputFolder
     # }
 
-    # LogGroup 'Build root module - Validate - File list' {
+    # Set-GitHubLogGroup 'Build root module - Validate - File list' {
     #     Get-ChildItem -Path $ModuleOutputFolder -Recurse -Force | Resolve-Path -Relative | Sort-Object
     # }
 }

scripts/helpers/Build/Update-PSModuleManifestAliasesToExport.ps1

@@ -29,7 +29,7 @@
         [Parameter(Mandatory)]
         [System.IO.DirectoryInfo] $ModuleOutputFolder
     )
-    LogGroup 'Updating aliases to export in module manifest' {
+    Set-GitHubLogGroup 'Updating aliases to export in module manifest' {
         Write-Host "Module name: [$ModuleName]"
         Write-Host "Module output folder: [$ModuleSourceFolder]"
 

scripts/main.ps1

@@ -6,7 +6,7 @@
 param()
 
 $path = (Join-Path -Path $PSScriptRoot -ChildPath 'helpers') | Get-Item | Resolve-Path -Relative
-LogGroup "Loading helper scripts from [$path]" {
+Set-GitHubLogGroup "Loading helper scripts from [$path]" {
     Get-ChildItem -Path $path -Filter '*.ps1' -Recurse | Resolve-Path -Relative | ForEach-Object {
         Write-Host "$_"
         . $_
@@ -15,7 +15,7 @@ LogGroup "Loading helper scripts from [$path]" {
 
 $env:GITHUB_REPOSITORY_NAME = $env:GITHUB_REPOSITORY -replace '.+/'
 
-LogGroup 'Loading inputs' {
+Set-GitHubLogGroup 'Loading inputs' {
     $moduleName = if ([string]::IsNullOrEmpty($env:PSMODULE_BUILD_PSMODULE_INPUT_Name)) {
         $env:GITHUB_REPOSITORY_NAME
     } else {
@@ -30,14 +30,14 @@ LogGroup 'Loading inputs' {
     } | Format-List | Out-String
 }
 
-LogGroup 'Build local scripts' {
+Set-GitHubLogGroup 'Build local scripts' {
     Write-Host 'Execution order:'
     $scripts = Get-ChildItem -Filter '*build.ps1' -Recurse | Sort-Object -Property Name | Resolve-Path -Relative
     $scripts | ForEach-Object {
         Write-Host " - $_"
     }
     $scripts | ForEach-Object {
-        LogGroup "Build local scripts - [$_]" {
+        Set-GitHubLogGroup "Build local scripts - [$_]" {
             . $_
         }
     }