🩹 [Patch]: Remove redundant step summary checks and update input variable handling in action scripts

Author: MariusStorhaug

.github/workflows/Action-Test.yml

@@ -58,17 +58,6 @@ jobs:
           Name: PSModuleTest
           WorkingDirectory: tests/srcTestRepo
 
-      - name: Check step summary is empty
-        shell: pwsh
-        run: |
-          $summary = Get-Content $env:GITHUB_STEP_SUMMARY -Raw
-          Write-Host "Step summary:"
-          Write-Host "[$summary]"
-          if (-not [string]::IsNullOrEmpty($summary)) {
-            throw "Step summary is not empty: $summary"
-          }
-          Write-Host "Step summary is empty as expected."
-
       - name: Lint documentation
         uses: super-linter/super-linter/[email protected]
         env:
@@ -96,14 +85,3 @@ jobs:
           Name: PSModuleTest
           WorkingDirectory: tests/srcTestRepo
           ShowSummaryOnSuccess: true
-
-      - name: Check step summary is not empty
-        shell: pwsh
-        run: |
-          $summary = Get-Content $env:GITHUB_STEP_SUMMARY -Raw
-          Write-Host "Step summary:"
-          Write-Host "[$summary]"
-          if ([string]::IsNullOrEmpty($summary)) {
-            throw "Step summary is empty, but expected not to be."
-          }
-          Write-Host "Step summary is not empty as expected."

action.yml

@@ -9,14 +9,14 @@ inputs:
   Name:
     description: Name of the module to process.
     required: false
-  WorkingDirectory:
-    description: The working directory where the script will run from.
-    required: false
-    default: '.'
   ShowSummaryOnSuccess:
     description: Show GitHub Step Summary even when all commands succeed.
     required: false
     default: 'false'
+  WorkingDirectory:
+    description: The working directory where the script will run from.
+    required: false
+    default: '.'
 
 runs:
   using: composite
@@ -27,8 +27,8 @@ runs:
     - name: Document-PSModule
       shell: pwsh
       env:
-        GITHUB_ACTION_INPUT_Name: ${{ inputs.Name }}
-        GITHUB_ACTION_INPUT_ShowSummaryOnSuccess: ${{ inputs.ShowSummaryOnSuccess }}
+        DOCUMENT_PSMODULE_INPUT_Name: ${{ inputs.Name }}
+        DOCUMENT_PSMODULE_INPUT_ShowSummaryOnSuccess: ${{ inputs.ShowSummaryOnSuccess }}
       working-directory: ${{ inputs.WorkingDirectory }}
       run: |
         # Build-PSModuleDocumentation

scripts/helpers/Build-PSModuleDocumentation.ps1

@@ -1,10 +1,10 @@
 function Build-PSModuleDocumentation {
     <#
-    .SYNOPSIS
-    Builds a module.
+        .SYNOPSIS
+        Builds a module.
 
-    .DESCRIPTION
-    Builds a module.
+        .DESCRIPTION
+        Builds a module.
     #>
     [CmdletBinding()]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
@@ -93,9 +93,9 @@
     $failedCommands = $commandResults | Where-Object { $_.Status -eq 'Failed' }
     $successfulCommands = $commandResults | Where-Object { $_.Status -eq 'Success' }
     $hasFailures = $failedCommands.Count -gt 0
-    $shouldShowSummary = $hasFailures -or $ShowSummaryOnSuccess
+    $shouldShowSummary = $ShowSummaryOnSuccess
 
-    # Generate summary if there are failures OR if ShowSummaryOnSuccess is enabled
+    # Generate summary if ShowSummaryOnSuccess is enabled
     if ($shouldShowSummary) {
         $statusIcon = $hasFailures ? '❌' : '✅'
         $statusText = $hasFailures ? 'Failed' : 'Succeeded'
@@ -111,13 +111,39 @@
 |---------|---------|
 | $successCount | $failureCount |
 
-## Command status
+"@
+
+        if ($failedCommands) {
+            $summaryContent += @"
+
+<details><summary>Failed</summary>
+
+<p>
+
+$(($failedCommands | ForEach-Object { "- ``$($_.CommandName)`` `n" }) -join '')
+
+</p>
+
+</details>
+
+"@
+        }
+
+        if ($successfulCommands) {
+            $summaryContent += @"
+
+<details><summary>Succeeded</summary>
 
-| Command | Status |
-|---------|--------|
-$(($commandResults | ForEach-Object { "| ``$($_.CommandName)`` | $($_.Status) |`n" }) -join '')
+<p>
+
+$(($successfulCommands | ForEach-Object { "- ``$($_.CommandName)`` `n" }) -join '')
+
+</p>
+
+</details>
 
 "@
+        }
 
 
         $summaryContent | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Encoding utf8 -Append

scripts/main.ps1

@@ -3,7 +3,10 @@
     Justification = 'Want to just write to the console, not the pipeline.'
 )]
 [CmdletBinding()]
-param()
+param(
+    [string]$Name = $env:DOCUMENT_PSMODULE_INPUT_Name,
+    [bool]$ShowSummaryOnSuccess = $env:DOCUMENT_PSMODULE_INPUT_ShowSummaryOnSuccess -eq 'true'
+)
 
 $PSStyle.OutputRendering = 'Ansi'
 
@@ -37,18 +40,16 @@ Get-ChildItem -Path $path -Filter '*.ps1' -Recurse | Resolve-Path -Relative | Fo
 
 Write-Host '::group::Loading inputs'
 $env:GITHUB_REPOSITORY_NAME = $env:GITHUB_REPOSITORY -replace '.+/'
-$moduleName = [string]::IsNullOrEmpty($env:GITHUB_ACTION_INPUT_Name) ? $env:GITHUB_REPOSITORY_NAME : $env:GITHUB_ACTION_INPUT_Name
-$showSummaryOnSuccess = $env:GITHUB_ACTION_INPUT_ShowSummaryOnSuccess -eq 'true'
 $moduleSourceFolderPath = Resolve-Path -Path 'src' | Select-Object -ExpandProperty Path
 $modulesOutputFolderPath = Join-Path -Path . -ChildPath 'outputs/module'
 $docsOutputFolderPath = Join-Path -Path . -ChildPath 'outputs/docs'
 
 $params = @{
-    ModuleName              = $moduleName
+    ModuleName              = [string]::IsNullOrEmpty($Name) ? $env:GITHUB_REPOSITORY_NAME : $Name
     ModuleSourceFolderPath  = $moduleSourceFolderPath
     ModulesOutputFolderPath = $modulesOutputFolderPath
     DocsOutputFolderPath    = $docsOutputFolderPath
-    ShowSummaryOnSuccess    = $showSummaryOnSuccess
+    ShowSummaryOnSuccess    = $ShowSummaryOnSuccess
 }
 
 [pscustomobject]$params | Format-List | Out-String