Skip to content

Commit dc7d1ff

Browse files
🩹 [Patch]: Improve clarity and formatting in README.md for script inputs and outputs
1 parent efe5cde commit dc7d1ff

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

‎README.md‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
# GitHub-Script
22

3-
A GitHub Action used for running a PowerShell Script that uses the GitHub PowerShell module.
3+
A GitHub Action for running a PowerShell script that uses the GitHub PowerShell module.
44

5-
For more information on the available functions and automatic loaded variables, see the
6-
[GitHub PowerShell module documentation](https://psmodule.io/GitHub)
5+
For more information on available functions and automatically loaded variables, see the
6+
[GitHub PowerShell module documentation](https://psmodule.io/GitHub).
77

88
## Usage
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, using the App's Client ID and Private Key. | false | |
17-
| `PrivateKey` | Log in using a GitHub App, using 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 version of the GitHub module to be installed. The value must be an exact version. | false | |
21-
| `Prerelease` | Allow prerelease versions if available. | false | `'false'` |
22-
| `ShowOutput` | Show the output of the script. | false | `'false'` |
23-
| `WorkingDirectory` | The working directory where the script will run from. | 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 output of the script 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

31-
To use the outputs in a subsequent step, you can use the following syntax:
31+
To use the outputs in a subsequent step, reference them as follows:
3232

3333
```yaml
3434
- uses: PSModule/GitHub-Script@v1
@@ -56,7 +56,7 @@ To use the outputs in a subsequent step, you can use the following syntax:
5656
5757
#### Example 1: Run a GitHub PowerShell script file
5858
59-
Run a script (`scripts/main.ps1`) that uses the GitHub PowerShell module, authenticated using the `GITHUB_TOKEN`.
59+
Runs a script (`scripts/main.ps1`) that uses the GitHub PowerShell module, authenticated using the `GITHUB_TOKEN`.
6060

6161
```yaml
6262
jobs:
@@ -112,6 +112,7 @@ The `Script` input supports the following formats:
112112
> Using `tests\info.ps1` is PowerShell syntax for calling a function under a specific module, i.e. `Microsoft.PowerShell.Management\Get-ChildItem`.
113113
>
114114

115+
115116
> [!TIP]
116117
> Use script files instead of inline scripts for better tooling support and linting capabilities. The PowerShell extension for Visual Studio Code and
117118
> PowerShell linters like PSScriptAnalyzer will work natively with script files.

0 commit comments

Comments
 (0)