Skip to content

Commit 39da908

Browse files
🔧 [Docs]: Add default PSModule.yml configuration example to README for clarity
1 parent 45698da commit 39da908

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

‎README.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,76 @@ Here's a Markdown-formatted table describing your PowerShell object structure cl
134134
| `Publish.Module.PatchLabels` | `String` | Labels indicating a patch version bump | `'patch, fix'` |
135135
| `Publish.Module.IgnoreLabels` | `String` | Labels indicating no release | `'NoRelease'` |
136136

137+
<details>
138+
<summary>`PSModule.yml` with all defaults</summary>
139+
140+
```yml
141+
Name: null
142+
143+
Build:
144+
Skip: false
145+
Module:
146+
Skip: false
147+
Docs:
148+
Skip: false
149+
Site:
150+
Skip: false
151+
152+
Test:
153+
Skip: false
154+
Linux:
155+
Skip: false
156+
MacOS:
157+
Skip: false
158+
Windows:
159+
Skip: false
160+
SourceCode:
161+
Skip: false
162+
Linux:
163+
Skip: false
164+
MacOS:
165+
Skip: false
166+
Windows:
167+
Skip: false
168+
PSModule:
169+
Skip: false
170+
Linux:
171+
Skip: false
172+
MacOS:
173+
Skip: false
174+
Windows:
175+
Skip: false
176+
Module:
177+
Skip: false
178+
Linux:
179+
Skip: false
180+
MacOS:
181+
Skip: false
182+
Windows:
183+
Skip: false
184+
TestResults:
185+
Skip: false
186+
CodeCoverage:
187+
Skip: false
188+
PercentTarget: 0
189+
StepSummaryMode: 'Missed, Files'
190+
191+
Publish:
192+
Module:
193+
Skip: false
194+
AutoCleanup: true
195+
AutoPatching: true
196+
IncrementalPrerelease: true
197+
DatePrereleaseFormat: ''
198+
VersionPrefix: 'v'
199+
MajorLabels: 'major, breaking'
200+
MinorLabels: 'minor, feature'
201+
PatchLabels: 'patch, fix'
202+
IgnoreLabels: 'NoRelease'
203+
204+
```
205+
</details>
206+
137207
### Example 1 - Rapid testing
138208

139209
This example runs all steps and will require that code coverage is 80% before passing.

0 commit comments

Comments
 (0)