psmodule/GitHub-Script (by PSModule)

A GitHub Action used for running a PowerShell script that uses the GitHub PowerShell module

Trust Signals

name	description	required	default
Name	The name of the action.	no	GitHub-Script
Script	The script to run. Can be inline, multi-line or a path to a script file.	no	—
Token	Log in using an Installation Access Token (IAT).	no	${{ github.token }}
ClientID	Log in using a GitHub App, using the App's Client ID and Private Key.	no	—
PrivateKey	Log in using a GitHub App, using the App's Client ID and Private Key.	no	—
KeyVaultKeyReference	Log in using a GitHub App, using the App's Client ID and KeyVault Key Reference.	no	—
Debug	Enable debug output for the whole action.	no	false
Verbose	Enable verbose output for the whole action.	no	false
Version	Specifies the version of the GitHub module to install. Accepts an exact version or a NuGet version range (for example '[1.2.0, 2.0.0)').	no	—
Prerelease	Allow prerelease versions if available.	no	false
ShowInfo	Show information about the environment.	no	true
ShowInit	Show information about the initialization.	no	false
ShowOutput	Show the output of the script.	no	false
ShowRateLimit	Show GitHub API rate limit information before and after script execution.	no	false
ErrorView	Configure the PowerShell `$ErrorView` variable. You can use full names ('NormalView', 'CategoryView', 'ConciseView', 'DetailedView'). It matches on partials.	no	NormalView
WorkingDirectory	The working directory where the script will run from.	no	.
PreserveCredentials	Preserve credentials after script execution. If false, disconnects GitHub contexts and CLI using Disconnect-GitHubAccount.	no	true

name	description
result	The output of the script as a JSON object. To add outputs to `result`, use `Set-GitHubOutput`.