Skip to content

Commit ddf490b

Browse files
🔧 [Docs]: Update README for consistency in configuration file format and add new settings
1 parent 3cbad1c commit ddf490b

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

‎README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ jobs:
101101
## Configuration
102102

103103
The workflow is configured using a settings file in the module repository.
104-
The file can be a JSON, YML or PSD1 file. By default it will look for `.github/PSModule.yml`.
104+
The file can be a `JSON`, `YAML` or `PSD1` file. By default it will look for `.github/PSModule.yml`.
105105

106106
The following settings are available in the settings file:
107107
Here's a Markdown-formatted table describing your PowerShell object structure clearly and concisely:
@@ -255,11 +255,12 @@ Build:
255255
| Name | Type | Description | Required | Default |
256256
| ---- | ---- | ----------- | -------- | ------- |
257257
| `Name` | `string` | The name of the module to process. This defaults to the repository name if nothing is specified. | `false` | N/A |
258-
| `Path` | `string` | The path to the source code of the module. | `false` | `src` |
259-
| `Version` | `string` | Specifies the version of the GitHub module to be installed. The value must be an exact version. | `false` | N/A |
258+
| `SettingsPath` | `string` | The path to the settings file. Settings in the settings file take precedence over the action inputs. | `false` | `.github/PSModule.yml` |
259+
| `Version` | `string` | Specifies the version of the GitHub module to be installed. The value must be an exact version. | `false` | `''` |
260260
| `Prerelease` | `boolean` | Whether to use a prerelease version of the 'GitHub' module. | `false` | `false` |
261261
| `Debug` | `boolean` | Whether to enable debug output. Adds a `debug` step to every job. | `false` | `false` |
262262
| `Verbose` | `boolean` | Whether to enable verbose output. | `false` | `false` |
263+
| `WorkingDirectory` | `string` | The path to the root of the repo. | `false` | `.` |
263264

264265
### Secrets
265266

0 commit comments

Comments
 (0)