Skip to content

Commit 45698da

Browse files
MariusStorhaugMariusStorhaug
committed
🔧 [Docs]: Update settings table in README for clarity and improved descriptions
1 parent 2c43659 commit 45698da

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

‎README.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -96,43 +96,43 @@ The file can be a JSON, YML or PSD1 file. By default it will look for `.github/P
9696
The following settings are available in the settings file:
9797
Here's a Markdown-formatted table describing your PowerShell object structure clearly and concisely:
9898

99-
| Name | Type | Description | Default |
100-
|----------------------------------------|-----------|---------------------------------------------|---------------------|
101-
| `Name` | `String` | Name of the module. Defaults to repo name. | `null` |
102-
| `Test.Skip` | `Boolean` | Skip all tests | `false` |
103-
| `Test.Linux.Skip` | `Boolean` | Skip tests on Linux | `false` |
104-
| `Test.MacOS.Skip` | `Boolean` | Skip tests on macOS | `false` |
105-
| `Test.Windows.Skip` | `Boolean` | Skip tests on Windows | `false` |
106-
| `Test.SourceCode.Skip` | `Boolean` | Skip source code tests | `false` |
107-
| `Test.SourceCode.Linux.Skip` | `Boolean` | Skip source code tests on Linux | `false` |
108-
| `Test.SourceCode.MacOS.Skip` | `Boolean` | Skip source code tests on macOS | `false` |
109-
| `Test.SourceCode.Windows.Skip` | `Boolean` | Skip source code tests on Windows | `false` |
110-
| `Test.PSModule.Skip` | `Boolean` | Skip PSModule framework tests | `false` |
111-
| `Test.PSModule.Linux.Skip` | `Boolean` | Skip PSModule framework tests on Linux | `false` |
112-
| `Test.PSModule.MacOS.Skip` | `Boolean` | Skip PSModule framework tests on macOS | `false` |
113-
| `Test.PSModule.Windows.Skip` | `Boolean` | Skip PSModule framework tests on Windows | `false` |
114-
| `Test.Module.Skip` | `Boolean` | Skip module tests | `false` |
115-
| `Test.Module.Linux.Skip` | `Boolean` | Skip module tests on Linux | `false` |
116-
| `Test.Module.MacOS.Skip` | `Boolean` | Skip module tests on macOS | `false` |
117-
| `Test.Module.Windows.Skip` | `Boolean` | Skip module tests on Windows | `false` |
118-
| `Test.TestResults.Skip` | `Boolean` | Skip test result processing | `false` |
119-
| `Test.CodeCoverage.Skip` | `Boolean` | Skip code coverage tests | `false` |
120-
| `Test.CodeCoverage.PercentTarget` | `Integer` | Target code coverage percentage | `0` |
121-
| `Test.CodeCoverage.StepSummaryMode` | `String` | Step summary mode for code coverage reports | `'Missed, Files'` |
122-
| `Build.Skip` | `Boolean` | Skip all build tasks | `false` |
123-
| `Build.Module.Skip` | `Boolean` | Skip module build | `false` |
124-
| `Build.Docs.Skip` | `Boolean` | Skip documentation build | `false` |
125-
| `Build.Site.Skip` | `Boolean` | Skip website build | `false` |
126-
| `Publish.Module.Skip` | `Boolean` | Skip module publishing | `false` |
127-
| `Publish.Module.AutoCleanup` | `Boolean` | Automatically cleanup old module versions | `true` |
128-
| `Publish.Module.AutoPatching` | `Boolean` | Automatically patch module version | `true` |
129-
| `Publish.Module.IncrementalPrerelease` | `Boolean` | Use incremental prerelease versioning | `true` |
130-
| `Publish.Module.DatePrereleaseFormat` | `String` | Format for date-based prerelease | `''` |
131-
| `Publish.Module.VersionPrefix` | `String` | Prefix for version tags | `'v'` |
132-
| `Publish.Module.MajorLabels` | `String` | Labels indicating a major version bump | `'major, breaking'` |
133-
| `Publish.Module.MinorLabels` | `String` | Labels indicating a minor version bump | `'minor, feature'` |
134-
| `Publish.Module.PatchLabels` | `String` | Labels indicating a patch version bump | `'patch, fix'` |
135-
| `Publish.Module.IgnoreLabels` | `String` | Labels indicating no release | `'NoRelease'` |
99+
| Name | Type | Description | Default |
100+
|----------------------------------------|-----------|----------------------------------------------------------------------------------------------------------|---------------------|
101+
| `Name` | `String` | Name of the module to publish. Defaults to repository name. | `null` |
102+
| `Test.Skip` | `Boolean` | Skip all tests | `false` |
103+
| `Test.Linux.Skip` | `Boolean` | Skip tests on Linux | `false` |
104+
| `Test.MacOS.Skip` | `Boolean` | Skip tests on macOS | `false` |
105+
| `Test.Windows.Skip` | `Boolean` | Skip tests on Windows | `false` |
106+
| `Test.SourceCode.Skip` | `Boolean` | Skip source code tests | `false` |
107+
| `Test.SourceCode.Linux.Skip` | `Boolean` | Skip source code tests on Linux | `false` |
108+
| `Test.SourceCode.MacOS.Skip` | `Boolean` | Skip source code tests on macOS | `false` |
109+
| `Test.SourceCode.Windows.Skip` | `Boolean` | Skip source code tests on Windows | `false` |
110+
| `Test.PSModule.Skip` | `Boolean` | Skip PSModule framework tests | `false` |
111+
| `Test.PSModule.Linux.Skip` | `Boolean` | Skip PSModule framework tests on Linux | `false` |
112+
| `Test.PSModule.MacOS.Skip` | `Boolean` | Skip PSModule framework tests on macOS | `false` |
113+
| `Test.PSModule.Windows.Skip` | `Boolean` | Skip PSModule framework tests on Windows | `false` |
114+
| `Test.Module.Skip` | `Boolean` | Skip module tests | `false` |
115+
| `Test.Module.Linux.Skip` | `Boolean` | Skip module tests on Linux | `false` |
116+
| `Test.Module.MacOS.Skip` | `Boolean` | Skip module tests on macOS | `false` |
117+
| `Test.Module.Windows.Skip` | `Boolean` | Skip module tests on Windows | `false` |
118+
| `Test.TestResults.Skip` | `Boolean` | Skip test result processing | `false` |
119+
| `Test.CodeCoverage.Skip` | `Boolean` | Skip code coverage tests | `false` |
120+
| `Test.CodeCoverage.PercentTarget` | `Integer` | Target code coverage percentage | `0` |
121+
| `Test.CodeCoverage.StepSummaryMode` | `String` | Step summary mode for code coverage reports | `'Missed, Files'` |
122+
| `Build.Skip` | `Boolean` | Skip all build tasks | `false` |
123+
| `Build.Module.Skip` | `Boolean` | Skip module build | `false` |
124+
| `Build.Docs.Skip` | `Boolean` | Skip documentation build | `false` |
125+
| `Build.Site.Skip` | `Boolean` | Skip website build | `false` |
126+
| `Publish.Module.Skip` | `Boolean` | Skip module publishing | `false` |
127+
| `Publish.Module.AutoCleanup` | `Boolean` | Automatically cleanup old prerelease module versions | `true` |
128+
| `Publish.Module.AutoPatching` | `Boolean` | Automatically patch module version | `true` |
129+
| `Publish.Module.IncrementalPrerelease` | `Boolean` | Use incremental prerelease versioning | `true` |
130+
| `Publish.Module.DatePrereleaseFormat` | `String` | Format for date-based prerelease ([.NET DateTime](https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings)) | `''` |
131+
| `Publish.Module.VersionPrefix` | `String` | Prefix for version tags | `'v'` |
132+
| `Publish.Module.MajorLabels` | `String` | Labels indicating a major version bump | `'major, breaking'` |
133+
| `Publish.Module.MinorLabels` | `String` | Labels indicating a minor version bump | `'minor, feature'` |
134+
| `Publish.Module.PatchLabels` | `String` | Labels indicating a patch version bump | `'patch, fix'` |
135+
| `Publish.Module.IgnoreLabels` | `String` | Labels indicating no release | `'NoRelease'` |
136136

137137
### Example 1 - Rapid testing
138138

0 commit comments

Comments
 (0)