@@ -9,24 +9,24 @@ For more information on available functions and automatically loaded variables,
99
1010### Inputs
1111
12- | Name | Description | Required | Default |
13- | --------------------| ------------------------------------------------------------------------------------------- | ----------| --- ---------------------------|
14- | ` Script ` | The script to run. Can be inline, multi-line, or a path to a script file. | false | |
15- | ` Token ` | Log in using an Installation Access Token (IAT). | false | ` ${{ github.token }} ` |
16- | ` ClientID ` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | |
17- | ` PrivateKey ` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | |
18- | ` Debug ` | Enable debug output. | false | ` 'false' ` |
19- | ` Verbose ` | Enable verbose output. | false | ` 'false' ` |
20- | ` Version ` | Specifies the exact version of the GitHub module to install. | false | |
21- | ` Prerelease ` | Allow pre-release versions if available. | false | ` 'false' ` |
22- | ` ShowOutput ` | Show the script's output. | false | ` 'false' ` |
23- | ` WorkingDirectory ` | The working directory where the script runs. | false | ` ${{ github.workspace }} ` |
12+ | Name | Description | Required | Default |
13+ | --------------------| ---------------------------------------------------------------------------| ----------| ---------------------------|
14+ | ` Script ` | The script to run. Can be inline, multi-line, or a path to a script file. | false | |
15+ | ` Token ` | Log in using an Installation Access Token (IAT). | false | ` ${{ github.token }} ` |
16+ | ` ClientID ` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | |
17+ | ` PrivateKey ` | Log in using a GitHub App, with the App's Client ID and Private Key. | false | |
18+ | ` Debug ` | Enable debug output. | false | ` 'false' ` |
19+ | ` Verbose ` | Enable verbose output. | false | ` 'false' ` |
20+ | ` Version ` | Specifies the exact version of the GitHub module to install. | false | |
21+ | ` Prerelease ` | Allow pre-release versions if available. | false | ` 'false' ` |
22+ | ` ShowOutput ` | Show the script's output. | false | ` 'false' ` |
23+ | ` WorkingDirectory ` | The working directory where the script runs. | false | ` ${{ github.workspace }} ` |
2424
2525### Outputs
2626
27- | Name | Description |
28- | ----------| ------------------------------------------------------------------------------------------------------ |
29- | ` result ` | The script output as a JSON object. To add outputs to ` result ` , use ` Set-GitHubOutput ` . |
27+ | Name | Description |
28+ | ----------| ---------------------------------------------------------------------------------------- |
29+ | ` result ` | The script output as a JSON object. To add outputs to ` result ` , use ` Set-GitHubOutput ` . |
3030
3131To use the outputs in a subsequent step, reference them as follows:
3232
@@ -110,7 +110,7 @@ The `Script` input supports these formats:
110110
111111
112112> [!TIP]
113- > Use script files instead of inline scripts for better tooling support and linting . The PowerShell extension for Visual Studio Code and
113+ > Use script files instead of inline scripts for better support for development tools and linters . The PowerShell extension for Visual Studio Code and
114114> linters like PSScriptAnalyzer work natively with script files.
115115
116116# ### Example 2: Run a GitHub PowerShell script without a token
@@ -196,9 +196,3 @@ Runs a script that uses the GitHub PowerShell module and outputs the result.
196196 Set-GitHubStepSummary -Summary $result.WISECAT
197197 Write-GitHubNotice -Message $result.Zen -Title 'GitHub Zen'
198198` ` `
199-
200- # # Related Projects
201-
202- - [actions/create-github-app-token](https://github.com/actions/create-github-app-token) – Functionality will be incorporated into the GitHub PowerShell module.
203- - [actions/github-script](https://github.com/actions/github-script)
204- - [PSModule/GitHub](https://github.com/PSModule/GitHub)
0 commit comments