🚀 [Feature]: Add an option to output the outputs (#18)

MariusStorhaug · web-flow · commit b19f29eebc24 · 2025-01-05T22:34:57.000+01:00
## Description ### New functionality * Added a new input parameter `ShowOutput` to display the script's output in the logs. (`.github/workflows/Action-Test.yml`, `action.yml`, `scripts/outputs.ps1`) [[1]](diffhunk://#diff-a12ae5c885b0673c0ff6f70c2670886907590d624626e07da4c52e01aeaf56a4R71) [[2]](diffhunk://#diff-1243c5424efaaa19bd8e813c5e6f6da46316e63761421b3e5f5c8ced9a36e6b6R37-R40) [[3]](diffhunk://#diff-ee715ca93229232e95883bf00629fd14e3bf174cdc17b723c4cc5d70e6a60a58R1-R31) ### Bug fixes * Corrected a typo in the `action.yml` file from `RunGitGubScript` to `RunGitHubScript`. (`action.yml`) ### Documentation improvements * Updated the `README.md` to include the new `ShowOutput` parameter and improved formatting. (`README.md`) [[1]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L5-R6) [[2]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R22) ### Other changes * Adjusted the PowerShell script to set the window and buffer size for better output readability. (`scripts/main.ps1`) ## Type of change  - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [x] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml
@@ -68,6 +68,7 @@ jobs:
           Debug: true
           Verbose: true
           Prerelease: true
+          ShowOutput: true
           Script: |
             $cat = Get-GitHubOctocat
             $zen = Get-GitHubZen
@@ -79,9 +80,10 @@ jobs:
         shell: pwsh
         env:
           result: ${{ steps.test.outputs.result }}
+          WISECAT: ${{ fromJson(steps.test.outputs.result).WISECAT }}
         run: |
           $result = $env:result | ConvertFrom-Json
-          Set-GitHubStepSummary -Summary $result.WISECAT
+          Set-GitHubStepSummary -Summary $env:WISECAT
           Write-GitHubNotice -Message $result.Zen -Title 'GitHub Zen'
 
   ActionTestWithoutToken:
diff --git a/README.md b/README.md
@@ -2,7 +2,8 @@
 
 A GitHub Action used for running a PowerShell Script that uses the GitHub PowerShell module.
 
-For more information on the available functions and automatic loaded variables, see the [GitHub PowerShell module documentation](https://psmodule.io/GitHub)
+For more information on the available functions and automatic loaded variables, see the
+[GitHub PowerShell module documentation](https://psmodule.io/GitHub)
 
 ## Usage
 
@@ -18,6 +19,7 @@ For more information on the available functions and automatic loaded variables,
 | `Verbose` | Enable verbose output. | false | `'false'` |
 | `Version` | Specifies the version of the GitHub module to be installed. The value must be an exact version. | false | |
 | `Prerelease` | Allow prerelease versions if available. | false | `'false'` |
+| `ShowOutput` | Show the output of the script. | false | `'false'` |
 | `WorkingDirectory` | The working directory where the script will run from. | false | `${{ github.workspace }}` |
 
 ### Outputs
diff --git a/action.yml b/action.yml
@@ -34,6 +34,10 @@ inputs:
     description: Allow prerelease versions if available.
     required: false
     default: 'false'
+  ShowOutput:
+    description: Show the output of the script.
+    required: false
+    default: 'false'
   WorkingDirectory:
     description: The working directory where the script will run from.
     required: false
@@ -42,14 +46,14 @@ inputs:
 outputs:
   result:
     description: The output of the script as a JSON object. To add outputs to `result`, use `Set-GitHubOutput`.
-    value: ${{ steps.RunGitGubScript.outputs.result }}
+    value: ${{ steps.RunGitHubScript.outputs.result }}
 
 runs:
   using: composite
   steps:
     - name: Install GitHub
       shell: pwsh
-      id: RunGitGubScript
+      id: RunGitHubScript
       working-directory: ${{ inputs.WorkingDirectory }}
       env:
         GITHUB_ACTION_INPUT_Token: ${{ inputs.Token }}
@@ -58,8 +62,10 @@ runs:
         GITHUB_ACTION_INPUT_Debug: ${{ inputs.Debug }}
         GITHUB_ACTION_INPUT_Verbose: ${{ inputs.Verbose }}
         GITHUB_ACTION_INPUT_Version: ${{ inputs.Version }}
+        GITHUB_ACTION_INPUT_ShowOutput: ${{ inputs.ShowOutput }}
         GITHUB_ACTION_INPUT_Prerelease: ${{ inputs.Prerelease }}
       run: |
         # GitHub-Script
-        . "${{ github.action_path }}\scripts\main.ps1"
+        . $(Join-Path -Path '${{ github.action_path }}' -ChildPath 'scripts\main.ps1')
         ${{ inputs.Script }}
+        . $(Join-Path -Path '${{ github.action_path }}' -ChildPath 'scripts\outputs.ps1')
diff --git a/scripts/main.ps1 b/scripts/main.ps1
@@ -1,6 +1,9 @@
 [CmdletBinding()]
 param()
 
+$Host.UI.RawUI.WindowSize.Width = 500
+$Host.UI.RawUI.BufferSize.Width = 500
+
 $env:PSMODULE_GITHUB_SCRIPT = $true
 Write-Host "┏━━━━━┫ GitHub-Script ┣━━━━━┓"
 Write-Host '::group:: - Setup GitHub PowerShell'
diff --git a/scripts/outputs.ps1 b/scripts/outputs.ps1
@@ -0,0 +1,31 @@
+﻿[CmdletBinding()]
+param()
+
+$DebugPreference = 'SilentlyContinue'
+$VerbosePreference = 'SilentlyContinue'
+
+if ($env:GITHUB_ACTION_INPUT_ShowOutput -ne 'true') {
+    return
+}
+
+$result = (Get-GitHubOutput).result
+if (-not $result) {
+    return
+}
+
+Write-Host '┏━━━━━┫ GitHub-Script ┣━━━━━┓'
+
+LogGroup ' - Outputs' {
+    if ([string]::IsNullOrEmpty($env:GITHUB_ACTION)) {
+        Write-GitHubWarning 'Outputs cannot be accessed as the step has no ID.'
+    }
+
+    if (-not (Test-Path -Path $env:GITHUB_OUTPUT)) {
+        Write-Warning "File not found: $env:GITHUB_OUTPUT"
+    }
+
+    $result | Format-List
+    Write-Host "Access outputs using `${{ fromJson(steps.$env:GITHUB_ACTION.outputs.result).<output-name> }}"
+}
+
+Write-Host '┗━━━━━━━━━━━━━━━━━━━━━━━━━━━┛'
