Skip to content

Commit 2c43659

Browse files
🔧 [Docs]: Update README to clarify module name description and improve test settings structure
1 parent 414774c commit 2c43659

File tree

1 file changed

+5
-13
lines changed

1 file changed

+5
-13
lines changed

‎README.md‎

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -98,39 +98,31 @@ Here's a Markdown-formatted table describing your PowerShell object structure cl
9898

9999
| Name | Type | Description | Default |
100100
|----------------------------------------|-----------|---------------------------------------------|---------------------|
101-
| `Name` | `String` | Name identifier for the settings | `null` |
102-
| **Test** | `Object` | Settings related to testing | |
101+
| `Name` | `String` | Name of the module. Defaults to repo name. | `null` |
103102
| `Test.Skip` | `Boolean` | Skip all tests | `false` |
104103
| `Test.Linux.Skip` | `Boolean` | Skip tests on Linux | `false` |
105104
| `Test.MacOS.Skip` | `Boolean` | Skip tests on macOS | `false` |
106105
| `Test.Windows.Skip` | `Boolean` | Skip tests on Windows | `false` |
107-
| **Test.SourceCode** | `Object` | Settings for source code tests | |
108106
| `Test.SourceCode.Skip` | `Boolean` | Skip source code tests | `false` |
109107
| `Test.SourceCode.Linux.Skip` | `Boolean` | Skip source code tests on Linux | `false` |
110108
| `Test.SourceCode.MacOS.Skip` | `Boolean` | Skip source code tests on macOS | `false` |
111109
| `Test.SourceCode.Windows.Skip` | `Boolean` | Skip source code tests on Windows | `false` |
112-
| **Test.PSModule** | `Object` | Settings for PSModule framework tests | |
113110
| `Test.PSModule.Skip` | `Boolean` | Skip PSModule framework tests | `false` |
114111
| `Test.PSModule.Linux.Skip` | `Boolean` | Skip PSModule framework tests on Linux | `false` |
115112
| `Test.PSModule.MacOS.Skip` | `Boolean` | Skip PSModule framework tests on macOS | `false` |
116113
| `Test.PSModule.Windows.Skip` | `Boolean` | Skip PSModule framework tests on Windows | `false` |
117-
| **Test.Module** | `Object` | Settings for module tests | |
118-
| `Test.Module.Skip` | `Boolean` | Skip module tests | `false` |
119-
| `Test.Module.Linux.Skip` | `Boolean` | Skip module tests on Linux | `false` |
120-
| `Test.Module.MacOS.Skip` | `Boolean` | Skip module tests on macOS | `false` |
121-
| `Test.Module.Windows.Skip` | `Boolean` | Skip module tests on Windows | `false` |
122-
| **Test.TestResults** | `Object` | Settings for test result publishing | |
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` |
123118
| `Test.TestResults.Skip` | `Boolean` | Skip test result processing | `false` |
124-
| **Test.CodeCoverage** | `Object` | Settings for code coverage | |
125119
| `Test.CodeCoverage.Skip` | `Boolean` | Skip code coverage tests | `false` |
126120
| `Test.CodeCoverage.PercentTarget` | `Integer` | Target code coverage percentage | `0` |
127121
| `Test.CodeCoverage.StepSummaryMode` | `String` | Step summary mode for code coverage reports | `'Missed, Files'` |
128-
| **Build** | `Object` | Settings for build processes | |
129122
| `Build.Skip` | `Boolean` | Skip all build tasks | `false` |
130123
| `Build.Module.Skip` | `Boolean` | Skip module build | `false` |
131124
| `Build.Docs.Skip` | `Boolean` | Skip documentation build | `false` |
132125
| `Build.Site.Skip` | `Boolean` | Skip website build | `false` |
133-
| **Publish.Module** | `Object` | Settings for module publishing | |
134126
| `Publish.Module.Skip` | `Boolean` | Skip module publishing | `false` |
135127
| `Publish.Module.AutoCleanup` | `Boolean` | Automatically cleanup old module versions | `true` |
136128
| `Publish.Module.AutoPatching` | `Boolean` | Automatically patch module version | `true` |

0 commit comments

Comments
 (0)