Move rate limit output inside existing Info and Outputs fences

Author: MariusStorhaug

action.yml

@@ -106,12 +106,8 @@ runs:
         try {
           ${{ github.action_path }}/src/init.ps1
           ${{ github.action_path }}/src/info.ps1
-          $env:PSMODULE_GITHUB_SCRIPT_RATELIMIT_LABEL = 'Pre'
-          ${{ github.action_path }}/src/ratelimit.ps1
           ${{ inputs.Script }}
           ${{ github.action_path }}/src/outputs.ps1
-          $env:PSMODULE_GITHUB_SCRIPT_RATELIMIT_LABEL = 'Post'
-          ${{ github.action_path }}/src/ratelimit.ps1
         }
         finally {
           ${{ github.action_path }}/src/clean.ps1

src/info.ps1

@@ -1,4 +1,4 @@
-#Requires -Modules GitHub
+#Requires -Modules GitHub
 
 [CmdletBinding()]
 param()
@@ -12,14 +12,19 @@ process {
     try {
         $fenceTitle = $env:PSMODULE_GITHUB_SCRIPT_INPUT_Name
 
-        Write-Debug "[$scriptName] - ShowInfo: $env:PSMODULE_GITHUB_SCRIPT_INPUT_ShowInfo"
-        if ($env:PSMODULE_GITHUB_SCRIPT_INPUT_ShowInfo -ne 'true') {
+        $showInfo = $env:PSMODULE_GITHUB_SCRIPT_INPUT_ShowInfo -eq 'true'
+        $showRateLimit = $env:PSMODULE_GITHUB_SCRIPT_INPUT_ShowRateLimit -eq 'true'
+
+        Write-Debug "[$scriptName] - ShowInfo: $showInfo"
+        Write-Debug "[$scriptName] - ShowRateLimit: $showRateLimit"
+        if (-not $showInfo -and -not $showRateLimit) {
             return
         }
 
         $fenceStart = "┏━━┫ $fenceTitle - Info ┣━━━━━━━━┓"
         Write-Output $fenceStart
 
+        if ($showInfo) {
         LogGroup ' - Installed modules' {
             Get-InstalledPSResource | Select-Object Name, Version, Prerelease | Sort-Object -Property Name | Format-Table -AutoSize | Out-String
         }
@@ -54,6 +59,10 @@ process {
         LogGroup ' - Event Information' {
             Get-GitHubEventData | Format-List | Out-String
         }
+        } # end if ($showInfo)
+
+        $env:PSMODULE_GITHUB_SCRIPT_RATELIMIT_LABEL = 'Pre'
+        & "$PSScriptRoot/ratelimit.ps1"
 
         $fenceEnd = '┗' + ('━' * ($fenceStart.Length - 2)) + '┛'
         Write-Output $fenceEnd

src/outputs.ps1

@@ -1,4 +1,4 @@
-#Requires -Modules GitHub
+#Requires -Modules GitHub
 
 [CmdletBinding()]
 param()
@@ -9,18 +9,26 @@ Write-Debug "[$scriptName] - Start"
 try {
     $fenceTitle = $env:PSMODULE_GITHUB_SCRIPT_INPUT_Name
 
-    Write-Debug "[$scriptName] - ShowOutput: $env:PSMODULE_GITHUB_SCRIPT_INPUT_ShowOutput"
-    if ($env:PSMODULE_GITHUB_SCRIPT_INPUT_ShowOutput -ne 'true') {
-        return
+    $showOutput = $env:PSMODULE_GITHUB_SCRIPT_INPUT_ShowOutput -eq 'true'
+    $showRateLimit = $env:PSMODULE_GITHUB_SCRIPT_INPUT_ShowRateLimit -eq 'true'
+
+    Write-Debug "[$scriptName] - ShowOutput: $showOutput"
+    Write-Debug "[$scriptName] - ShowRateLimit: $showRateLimit"
+
+    $result = $null
+    if ($showOutput) {
+        $result = (Get-GitHubOutput).result
+        Write-Debug "[$scriptName] - Result: $(-not $result)"
     }
 
-    $result = (Get-GitHubOutput).result
-    Write-Debug "[$scriptName] - Result: $(-not $result)"
-    if (-not $result) {
+    if (-not $result -and -not $showRateLimit) {
         return
     }
+
     $fenceStart = "┏━━┫ $fenceTitle - Outputs ┣━━━━━┓"
     Write-Output $fenceStart
+
+    if ($result) {
     if ([string]::IsNullOrEmpty($env:GITHUB_ACTION)) {
         Write-GitHubWarning 'Outputs cannot be accessed as the step has no ID.'
     }
@@ -36,6 +44,11 @@ try {
             $output.Value | Format-List | Out-String
         }
     }
+    } # end if ($result)
+
+    $env:PSMODULE_GITHUB_SCRIPT_RATELIMIT_LABEL = 'Post'
+    & "$PSScriptRoot/ratelimit.ps1"
+
     $fenceEnd = '┗' + ('━' * ($fenceStart.Length - 2)) + '┛'
     Write-Output $fenceEnd
 } catch {

src/ratelimit.ps1

@@ -1,34 +1,18 @@
 #Requires -Modules GitHub
 
-[CmdletBinding()]
-param()
+# Helper script - called from info.ps1 and outputs.ps1 to display rate limit information.
+# Expects $env:PSMODULE_GITHUB_SCRIPT_RATELIMIT_LABEL to be set to 'Pre' or 'Post'.
 
-$scriptName = $MyInvocation.MyCommand.Name
-Write-Debug "[$scriptName] - Start"
-
-try {
-    if ($env:PSMODULE_GITHUB_SCRIPT_INPUT_ShowRateLimit -ne 'true') {
-        return
-    }
-
-    $fenceTitle = $env:PSMODULE_GITHUB_SCRIPT_INPUT_Name
-    $label = $env:PSMODULE_GITHUB_SCRIPT_RATELIMIT_LABEL
+if ($env:PSMODULE_GITHUB_SCRIPT_INPUT_ShowRateLimit -ne 'true') {
+    return
+}
 
-    $fenceStart = "┏━━┫ $fenceTitle - Rate Limit ($label) ┣━━━━━━━━┓"
-    Write-Output $fenceStart
+$label = $env:PSMODULE_GITHUB_SCRIPT_RATELIMIT_LABEL
 
-    LogGroup " - Rate Limit ($label)" {
-        try {
-            Get-GitHubRateLimit | Format-Table -AutoSize | Out-String
-        } catch {
-            Write-Warning "Could not retrieve rate limit information: $($_.Exception.Message)"
-        }
+LogGroup " - Rate Limit ($label)" {
+    try {
+        Get-GitHubRateLimit | Format-Table -AutoSize | Out-String
+    } catch {
+        Write-Warning "Could not retrieve rate limit information: $($_.Exception.Message)"
     }
-
-    $fenceEnd = '┗' + ('━' * ($fenceStart.Length - 2)) + '┛'
-    Write-Output $fenceEnd
-} catch {
-    throw $_
 }
-
-Write-Debug "[$scriptName] - End"