Skip to content

🚀 [Minor]: GitHub API rate limit details now available in action logs #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Marius Storhaug (MariusStorhaug) merged 15 commits into from
May 16, 2026
Merged

🚀 [Minor]: GitHub API rate limit details now available in action logs #89

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
27ecb45
Add ShowRateLimit option to display API rate limits before and after …
MariusStorhaug Apr 13, 2026
3a4cf93
Add ShowRateLimit: true to test jobs for each auth type
MariusStorhaug Apr 13, 2026
b2b048d
Handle unsupported auth types gracefully in ratelimit.ps1
MariusStorhaug Apr 13, 2026
8b8c9ef
Move rate limit output inside existing Info and Outputs fences
MariusStorhaug Apr 13, 2026
2953c59
Fix indentation and add UTF-8 BOM to info.ps1 and outputs.ps1
MariusStorhaug Apr 13, 2026
591a756
Add ShowRateLimit to all test cases
Claude Apr 16, 2026
9fcba3b
Harden rate limit logging per review feedback
MariusStorhaug May 16, 2026
0d70e33
Simplify rate limit log group titles
MariusStorhaug May 16, 2026
e11b3ec
Rename log group to Rate Limits
MariusStorhaug May 16, 2026
91b9923
Clarify outputs debug presence logging
MariusStorhaug May 16, 2026
e898fbe
Document ShowRateLimit input and add usage example
MariusStorhaug May 16, 2026
f8e601e
Remove bracket end-if comments
MariusStorhaug May 16, 2026
5b52a7e
Fix terminology: graphql -> GraphQL in README
MariusStorhaug May 16, 2026
98dd1ef
Use inline code for rate limit category names in README
MariusStorhaug May 16, 2026
14576fd
Remove unnecessary end comment for result check in outputs.ps1
MariusStorhaug May 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add ShowRateLimit option to display API rate limits before and after … 
…script execution
  • Loading branch information
@MariusStorhaug
MariusStorhaug committed Apr 13, 2026
commit 27ecb45c630873139a080e695efa7529db976eae
9 changes: 9 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@
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'
Comment thread
MariusStorhaug marked this conversation as resolved.
ErrorView:
description: Configure the PowerShell `$ErrorView` variable. You can use full names ('NormalView', 'CategoryView', 'ConciseView', 'DetailedView'). It matches on partials.
required: false
Expand Down Expand Up @@ -91,6 +95,7 @@
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: |
Expand All @@ -101,8 +106,12 @@
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

Check warning

Code scanning / CodeQL

Code injection Medium

Potential code injection in
${ github.action_path }
Loading
, which may be controlled by an external user.
Comment thread
MariusStorhaug marked this conversation as resolved.
Fixed
${{ inputs.Script }}
${{ github.action_path }}/src/outputs.ps1
$env:PSMODULE_GITHUB_SCRIPT_RATELIMIT_LABEL = 'Post'
${{ github.action_path }}/src/ratelimit.ps1

Check warning

Code scanning / CodeQL

Code injection Medium

Potential code injection in
${ github.action_path }
Loading
, which may be controlled by an external user.
Comment thread
MariusStorhaug marked this conversation as resolved.
Fixed
}
finally {
${{ github.action_path }}/src/clean.ps1
Expand Down
30 changes: 30 additions & 0 deletions src/ratelimit.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
#Requires -Modules GitHub

[CmdletBinding()]
param()

$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

$fenceStart = "┏━━┫ $fenceTitle - Rate Limit ($label) ┣━━━━━━━━┓"
Write-Output $fenceStart

LogGroup " - Rate Limit ($label)" {
Get-GitHubRateLimit | Format-Table -AutoSize | Out-String
Comment thread
MariusStorhaug marked this conversation as resolved.
Outdated
}

$fenceEnd = '┗' + ('━' * ($fenceStart.Length - 2)) + '┛'
Write-Output $fenceEnd
} catch {
throw $_
}

Write-Debug "[$scriptName] - End"
Loading