Skip to content

Commit 69b84c1

Browse files
Revert README to original - docs belong in Process-PSModule
1 parent 199730c commit 69b84c1

1 file changed

Lines changed: 0 additions & 39 deletions

File tree

README.md

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,3 @@
11
# Get-PSModuleSettings
22

33
This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule).
4-
5-
## Inputs
6-
7-
| Input | Description | Required | Default |
8-
| :---- | :---------- | :------: | :------ |
9-
| `Name` | Name of the module. | No | Repository name |
10-
| `SettingsPath` | Path to the settings file (json, yaml/yml, or psd1). | No | |
11-
| `ImportantFilePatterns` | Newline-separated list of regular expression patterns that identify important files. Changes matching these patterns trigger build, test, and publish stages. | No | `^src/` and `^README\.md$` |
12-
| `Debug` | Enable debug output. | No | `false` |
13-
| `Verbose` | Enable verbose output. | No | `false` |
14-
| `Version` | Specifies the version of the GitHub module to be installed. | No | |
15-
| `Prerelease` | Allow prerelease versions if available. | No | `false` |
16-
| `WorkingDirectory` | The working directory where the script will run from. | No | `${{ github.workspace }}` |
17-
18-
## Settings file
19-
20-
The action reads settings from a file (default: `.github/PSModule.yml`). Settings in the file take precedence over action inputs.
21-
22-
### ImportantFilePatterns
23-
24-
Controls which file changes trigger build, test, and publish stages. When a PR only changes files that don't match any
25-
of these patterns, those stages are skipped.
26-
27-
Default patterns (used when not configured):
28-
29-
- `^src/` — Module source code
30-
- `^README\.md$` — Root documentation
31-
32-
To override, add `ImportantFilePatterns` to your settings file:
33-
34-
```yaml
35-
ImportantFilePatterns:
36-
- '^src/'
37-
- '^README\.md$'
38-
- '^examples/'
39-
```
40-
41-
When configured, the provided list fully replaces the defaults. Include the default patterns in your list if you still
42-
want them to trigger releases.

0 commit comments

Comments
 (0)