Merge branch 'dependabot/github_actions/super-linter/super-linter-8.6.0' of https://github.com/PSModule/GitHub-Script into dependabot/github_actions/super-linter/super-linter-8.6.0

Author: MariusStorhaug

.github/workflows/TestWorkflow.yml

@@ -62,6 +62,7 @@ jobs:
           Prerelease: ${{ inputs.Prerelease }}
           Debug: true
           Verbose: true
+          ShowRateLimit: true
 
       - name: Action-Test [ShowInit]
         uses: ./
@@ -70,6 +71,7 @@ jobs:
           Debug: true
           Verbose: true
           ShowInit: true
+          ShowRateLimit: true
 
   ActionTestWithScript:
     name: WithScript
@@ -95,48 +97,55 @@ jobs:
         with:
           Script: tests/info.ps1
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
 
       - name: Action-Test [.\tests\info.ps1]
         if: success() || failure()
         uses: ./
         with:
           Script: .\tests\info.ps1
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
 
       - name: Action-Test [./tests/info.ps1]
         if: success() || failure()
         uses: ./
         with:
           Script: ./tests/info.ps1
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
 
       - name: Action-Test [. .\tests\info.ps1]
         if: success() || failure()
         uses: ./
         with:
           Script: . .\tests\info.ps1
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
 
       - name: Action-Test [. ./tests/info.ps1]
         if: success() || failure()
         uses: ./
         with:
           Script: . ./tests/info.ps1
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
 
       - name: Action-Test [. '.\tests\info.ps1']
         if: success() || failure()
         uses: ./
         with:
           Script: . '.\tests\info.ps1'
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
 
       - name: Action-Test [. './tests/info.ps1']
         if: success() || failure()
         uses: ./
         with:
           Script: . './tests/info.ps1'
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
 
   ActionTestCommands:
     name: Commands + Outputs
@@ -159,6 +168,7 @@ jobs:
           Prerelease: ${{ inputs.Prerelease }}
           ShowInit: true
           ShowOutput: true
+          ShowRateLimit: true
           Script: |
             LogGroup 'Get-GitHubZen' {
               $cat = Get-GitHubOctocat
@@ -339,6 +349,7 @@ jobs:
           Prerelease: true
           ShowInit: true
           ShowOutput: true
+          ShowRateLimit: true
           Script: |
             LogGroup 'MatrixTest' {
                 $matrixTest = @{
@@ -398,6 +409,7 @@ jobs:
         with:
           Token: ''
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
           Script: |
             LogGroup 'My group' {
               'This is a group'
@@ -417,6 +429,7 @@ jobs:
         with:
           Token: ${{ secrets.TEST_USER_PAT }}
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
           Script: |
             LogGroup 'Get-GitHubUser' {
               Get-GitHubUser -Debug | Format-Table -AutoSize | Out-String
@@ -444,6 +457,7 @@ jobs:
         with:
           Token: ${{ secrets.TEST_USER_USER_FG_PAT }}
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
           Script: |
             LogGroup 'Get-GitHubUser' {
               Get-GitHubUser | Format-Table -AutoSize | Out-String
@@ -471,6 +485,7 @@ jobs:
         with:
           Token: ${{ secrets.TEST_USER_ORG_FG_PAT }}
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
           Script: |
             LogGroup 'Get-GitHubUser' {
               Get-GitHubUser | Format-Table -AutoSize | Out-String
@@ -499,6 +514,7 @@ jobs:
           ClientID: ${{ secrets.TEST_APP_ENT_CLIENT_ID }}
           PrivateKey: ${{ secrets.TEST_APP_ENT_PRIVATE_KEY }}
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
           Script: |
             LogGroup 'Get-GitHubApp' {
               Get-GitHubApp | Format-List | Out-String
@@ -535,6 +551,7 @@ jobs:
           ClientID: '${{ secrets.TEST_APP_ORG_CLIENT_ID }}'      # Test with quotes on input
           PrivateKey: '${{ secrets.TEST_APP_ORG_PRIVATE_KEY }}'  # Test with quotes on input
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
           Script: |
             LogGroup 'Get-GitHubApp' {
               Get-GitHubApp | Format-List | Out-String
@@ -581,6 +598,7 @@ jobs:
           ClientID: ${{ secrets.TEST_APP_ORG_CLIENT_ID }}
           KeyVaultKeyReference: 'https://psmodule-test-vault.vault.azure.net/keys/psmodule-org-app/569ae34250e64adca6a2b2d159d454a5'
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
           Script: |
             LogGroup 'Context details' {
                 Get-GitHubContext | Select-Object * | Out-String
@@ -631,6 +649,7 @@ jobs:
           ClientID: ${{ secrets.TEST_APP_ORG_CLIENT_ID }}
           KeyVaultKeyReference: 'https://psmodule-test-vault.vault.azure.net/keys/psmodule-org-app/'
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
           Script: |
             LogGroup 'Context details' {
                 Get-GitHubContext | Select-Object * | Out-String
@@ -671,6 +690,7 @@ jobs:
           Token: ${{ secrets.TEST_USER_PAT }}
           PreserveCredentials: false
           Prerelease: ${{ inputs.Prerelease }}
+          ShowRateLimit: true
           Script: |
             LogGroup 'Get-GitHubUser with credentials that will be cleaned up' {
               Get-GitHubUser | Format-Table -AutoSize | Out-String

README.md

@@ -24,6 +24,7 @@ To get started with your own GitHub PowerShell based action, [create a new repos
 | `ShowInfo`             | Show information about the environment.                                                                                                                       | false    | `'true'`              |
 | `ShowInit`             | Show information about the initialization.                                                                                                                    | false    | `'false'`             |
 | `ShowOutput`           | Show the script's output.                                                                                                                                     | false    | `'false'`             |
+| `ShowRateLimit`        | Show GitHub API rate limit information before and after script execution.                                                                                     | false    | `'false'`             |
 | `WorkingDirectory`     | The working directory where the script runs.                                                                                                                  | false    | `'.'`                 |
 | `PreserveCredentials`  | Preserve credentials after script execution. If false, disconnects GitHub contexts and CLI using Disconnect-GitHubAccount.                                    | false    | `'true'`              |
 
@@ -243,3 +244,16 @@ Runs a script with `PreserveCredentials` set to `false` to automatically disconn
       Get-GitHubUser
       # Credentials will be disconnected after this step
 ```
+
+#### Example 8: Show GitHub API rate limit usage
+
+Displays the GitHub API rate limit status before and after the script runs. The **Rate Limits** log group shows `Limit`, `Used`, `Remaining`, `ResetsAt`, and `ResetsIn` for every resource category (`core`, `search`, `graphql`, etc.), making it easy to see exactly how many API calls a workflow step consumed.
+
+```yaml
+- name: Run script with rate limit visibility
+  uses: PSModule/GitHub-Script@v1
+  with:
+    ShowRateLimit: 'true'
+    Script: |
+      Get-GitHubRepository -Owner PSModule -Name GitHub-Script
+```

action.yml

@@ -53,6 +53,10 @@ inputs:
     description: Show the output of the script.
     required: false
     default: 'false'
+  ShowRateLimit:
+    description: Show GitHub API rate limit information before and after script execution.
+    required: false
+    default: 'false'
   ErrorView:
     description: Configure the PowerShell `$ErrorView` variable. You can use full names ('NormalView', 'CategoryView', 'ConciseView', 'DetailedView'). It matches on partials.
     required: false
@@ -91,6 +95,7 @@ runs:
         PSMODULE_GITHUB_SCRIPT_INPUT_ShowInfo: ${{ inputs.ShowInfo }}
         PSMODULE_GITHUB_SCRIPT_INPUT_ShowOutput: ${{ inputs.ShowOutput }}
         PSMODULE_GITHUB_SCRIPT_INPUT_Prerelease: ${{ inputs.Prerelease }}
+        PSMODULE_GITHUB_SCRIPT_INPUT_ShowRateLimit: ${{ inputs.ShowRateLimit }}
         PSMODULE_GITHUB_SCRIPT_INPUT_ErrorView: ${{ inputs.ErrorView }}
         PSMODULE_GITHUB_SCRIPT_INPUT_PreserveCredentials: ${{ inputs.PreserveCredentials }}
       run: |

src/info.ps1

@@ -12,49 +12,57 @@ 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
 
-        LogGroup ' - Installed modules' {
-            Get-InstalledPSResource | Select-Object Name, Version, Prerelease | Sort-Object -Property Name | Format-Table -AutoSize | Out-String
-        }
+        if ($showInfo) {
+            LogGroup ' - Installed modules' {
+                Get-InstalledPSResource | Select-Object Name, Version, Prerelease | Sort-Object -Property Name | Format-Table -AutoSize | Out-String
+            }
 
-        LogGroup ' - GitHub connection - Default' {
-            $context = Get-GitHubContext
-            $context | Format-List | Out-String
-
-            Write-Verbose "Token?    [$([string]::IsNullOrEmpty($env:PSMODULE_GITHUB_SCRIPT_INPUT_Token))]"
-            Write-Verbose "AuthType? [$($context.AuthType)] - [$($context.AuthType -ne 'APP')]"
-            Write-Verbose "gh auth?  [$($context.AuthType -ne 'APP' -and -not [string]::IsNullOrEmpty($env:PSMODULE_GITHUB_SCRIPT_INPUT_Token))]"
-
-            if ($context.AuthType -ne 'APP' -and -not [string]::IsNullOrEmpty($env:PSMODULE_GITHUB_SCRIPT_INPUT_Token)) {
-                Write-Output 'GitHub CLI status:'
-                $before = $LASTEXITCODE
-                gh auth status
-                if ($LASTEXITCODE -ne $before) {
-                    Write-Warning "LASTEXITCODE has changed [$LASTEXITCODE]"
-                    $global:LASTEXITCODE = $before
+            LogGroup ' - GitHub connection - Default' {
+                $context = Get-GitHubContext
+                $context | Format-List | Out-String
+
+                Write-Verbose "Token?    [$([string]::IsNullOrEmpty($env:PSMODULE_GITHUB_SCRIPT_INPUT_Token))]"
+                Write-Verbose "AuthType? [$($context.AuthType)] - [$($context.AuthType -ne 'APP')]"
+                Write-Verbose "gh auth?  [$($context.AuthType -ne 'APP' -and -not [string]::IsNullOrEmpty($env:PSMODULE_GITHUB_SCRIPT_INPUT_Token))]"
+
+                if ($context.AuthType -ne 'APP' -and -not [string]::IsNullOrEmpty($env:PSMODULE_GITHUB_SCRIPT_INPUT_Token)) {
+                    Write-Output 'GitHub CLI status:'
+                    $before = $LASTEXITCODE
+                    gh auth status
+                    if ($LASTEXITCODE -ne $before) {
+                        Write-Warning "LASTEXITCODE has changed [$LASTEXITCODE]"
+                        $global:LASTEXITCODE = $before
+                    }
                 }
             }
-        }
 
-        LogGroup ' - GitHub connection - List' {
-            Get-GitHubContext -ListAvailable | Format-Table | Out-String
-        }
+            LogGroup ' - GitHub connection - List' {
+                Get-GitHubContext -ListAvailable | Format-Table | Out-String
+            }
 
-        LogGroup ' - Configuration' {
-            Get-GitHubConfig | Format-List | Out-String
-        }
+            LogGroup ' - Configuration' {
+                Get-GitHubConfig | Format-List | Out-String
+            }
 
-        LogGroup ' - Event Information' {
-            Get-GitHubEventData | Format-List | Out-String
+            LogGroup ' - Event Information' {
+                Get-GitHubEventData | Format-List | Out-String
+            }
         }
 
+        & "$PSScriptRoot/ratelimit.ps1"
+
         $fenceEnd = '┗' + ('━' * ($fenceStart.Length - 2)) + '┛'
         Write-Output $fenceEnd
     } catch {

src/outputs.ps1

@@ -9,33 +9,47 @@ 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
+    $hasResult = $false
+    if ($showOutput) {
+        $result = (Get-GitHubOutput).result
+        $hasResult = [bool]$result
+        Write-Debug "[$scriptName] - ResultPresent: $hasResult"
     }
 
-    $result = (Get-GitHubOutput).result
-    Write-Debug "[$scriptName] - Result: $(-not $result)"
-    if (-not $result) {
+    if (-not $hasResult -and -not $showRateLimit) {
         return
     }
+
     $fenceStart = "┏━━┫ $fenceTitle - Outputs ┣━━━━━┓"
     Write-Output $fenceStart
-    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"
-    }
+    if ($hasResult) {
+        if ([string]::IsNullOrEmpty($env:GITHUB_ACTION)) {
+            Write-GitHubWarning 'Outputs cannot be accessed as the step has no ID.'
+        }
 
-    foreach ($output in $result.PSObject.Properties) {
-        $blue = $PSStyle.Foreground.Blue
-        $reset = $PSStyle.Reset
-        LogGroup " - $blue$($output.Name)$reset" {
-            $output.Value | Format-List | Out-String
+        if (-not (Test-Path -Path $env:GITHUB_OUTPUT)) {
+            Write-Warning "File not found: $env:GITHUB_OUTPUT"
+        }
+
+        foreach ($output in $result.PSObject.Properties) {
+            $blue = $PSStyle.Foreground.Blue
+            $reset = $PSStyle.Reset
+            LogGroup " - $blue$($output.Name)$reset" {
+                $output.Value | Format-List | Out-String
+            }
         }
     }
+
+    & "$PSScriptRoot/ratelimit.ps1"
+
     $fenceEnd = '┗' + ('━' * ($fenceStart.Length - 2)) + '┛'
     Write-Output $fenceEnd
 } catch {

src/ratelimit.ps1

@@ -0,0 +1,17 @@
+#Requires -Modules GitHub
+
+# Helper script - called from info.ps1 and outputs.ps1 to display rate limit information.
+
+if ($env:PSMODULE_GITHUB_SCRIPT_INPUT_ShowRateLimit -ne 'true') {
+    return
+}
+
+LogGroup ' - Rate Limits' {
+    try {
+        Get-GitHubRateLimit -ErrorAction Stop |
+            Select-Object Name, Limit, Used, Remaining, ResetsAt, ResetsIn |
+            Format-Table -AutoSize | Out-String
+    } catch {
+        Write-Warning "Could not retrieve rate limit information: $($_.Exception.Message)"
+    }
+}