Skip to content

Commit b84be00

Browse files
MariusStorhaugMariusStorhaug
authored
🩹 [Patch]: Expose VerbosePreference and DebugPreference to Test-PSModule (#66)
## Description This pull request includes updates to the CI workflow configuration files to add new input parameters for verbose and debug output preferences. Additionally, the README file has been updated to document these new parameters. Workflow configuration updates: * [`.github/workflows/CI.yml`](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R65-R74): Added `VerbosePreference` and `DebugPreference` parameters to the workflow inputs and included these parameters in the job definitions. [[1]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R65-R74) [[2]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R110-R111) [[3]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R136-R137) [[4]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R162-R163) [[5]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R224-R225) [[6]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R268-R269) [[7]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8R312-R313) * [`.github/workflows/workflow.yml`](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R70-R79): Added `VerbosePreference` and `DebugPreference` parameters to the workflow inputs and included these parameters in the job definitions. [[1]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R70-R79) [[2]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R117-R118) [[3]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R143-R144) [[4]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R169-R170) [[5]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R231-R232) [[6]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R275-R276) [[7]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R319-R320) Documentation updates: * [`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L78-R83): Documented the new `VerbosePreference` and `DebugPreference` parameters. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
1 parent 8c7bd2c commit b84be00

File tree

3 files changed

+50
-4
lines changed

3 files changed

+50
-4
lines changed

‎.github/workflows/CI.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,16 @@ on:
6262
description: Whether to publish the documentation using MkDocs and GitHub Pages.
6363
required: false
6464
default: true
65+
VerbosePreference:
66+
type: string
67+
description: "The preference for verbose output. Allowed values: 'SilentlyContinue', 'Stop', 'Continue', 'Inquire', 'Break', 'Ignore','Suspend'."
68+
required: false
69+
default: 'SilentlyContinue'
70+
DebugPreference:
71+
type: string
72+
description: "The preference for debug output. Allowed values: 'SilentlyContinue', 'Stop', 'Continue', 'Inquire', 'Break', 'Ignore','Suspend'."
73+
required: false
74+
default: 'SilentlyContinue'
6575

6676
env:
6777
GITHUB_TOKEN: ${{ github.token }} # Used for GitHub CLI authentication
@@ -97,6 +107,8 @@ jobs:
97107
Name: ${{ inputs.Name }}
98108
Path: ${{ inputs.Path }}
99109
TestType: SourceCode
110+
VerbosePreference: ${{ inputs.VerbosePreference }}
111+
DebugPreference: ${{ inputs.DebugPreference }}
100112

101113
TestSourceCode-pwsh-macos-latest:
102114
name: Test source code (pwsh, macos-latest)
@@ -121,6 +133,8 @@ jobs:
121133
Name: ${{ inputs.Name }}
122134
Path: ${{ inputs.Path }}
123135
TestType: SourceCode
136+
VerbosePreference: ${{ inputs.VerbosePreference }}
137+
DebugPreference: ${{ inputs.DebugPreference }}
124138

125139
TestSourceCode-pwsh-windows-latest:
126140
name: Test source code (pwsh, windows-latest)
@@ -145,6 +159,8 @@ jobs:
145159
Name: ${{ inputs.Name }}
146160
Path: ${{ inputs.Path }}
147161
TestType: SourceCode
162+
VerbosePreference: ${{ inputs.VerbosePreference }}
163+
DebugPreference: ${{ inputs.DebugPreference }}
148164

149165
BuildModule:
150166
name: Build module
@@ -205,6 +221,8 @@ jobs:
205221
Name: ${{ inputs.Name }}
206222
Path: ${{ inputs.ModulesOutputPath }}
207223
TestType: Module
224+
VerbosePreference: ${{ inputs.VerbosePreference }}
225+
DebugPreference: ${{ inputs.DebugPreference }}
208226

209227
- name: Status
210228
shell: pwsh
@@ -247,6 +265,8 @@ jobs:
247265
Name: ${{ inputs.Name }}
248266
Path: ${{ inputs.ModulesOutputPath }}
249267
TestType: Module
268+
VerbosePreference: ${{ inputs.VerbosePreference }}
269+
DebugPreference: ${{ inputs.DebugPreference }}
250270

251271
- name: Status
252272
shell: pwsh
@@ -289,6 +309,8 @@ jobs:
289309
Name: ${{ inputs.Name }}
290310
Path: ${{ inputs.ModulesOutputPath }}
291311
TestType: Module
312+
VerbosePreference: ${{ inputs.VerbosePreference }}
313+
DebugPreference: ${{ inputs.DebugPreference }}
292314

293315
- name: Status
294316
shell: pwsh

‎.github/workflows/workflow.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,16 @@ on:
6767
description: Whether to publish the documentation using MkDocs and GitHub Pages.
6868
required: false
6969
default: true
70+
VerbosePreference:
71+
type: string
72+
description: "The preference for verbose output. Allowed values: 'SilentlyContinue', 'Stop', 'Continue', 'Inquire', 'Break', 'Ignore','Suspend'."
73+
required: false
74+
default: 'SilentlyContinue'
75+
DebugPreference:
76+
type: string
77+
description: "The preference for debug output. Allowed values: 'SilentlyContinue', 'Stop', 'Continue', 'Inquire', 'Break', 'Ignore','Suspend'."
78+
required: false
79+
default: 'SilentlyContinue'
7080

7181
env:
7282
GITHUB_TOKEN: ${{ github.token }} # Used for GitHub CLI authentication
@@ -104,6 +114,8 @@ jobs:
104114
Name: ${{ inputs.Name }}
105115
Path: ${{ inputs.Path }}
106116
TestType: SourceCode
117+
VerbosePreference: ${{ inputs.VerbosePreference }}
118+
DebugPreference: ${{ inputs.DebugPreference }}
107119

108120
TestSourceCode-pwsh-macos-latest:
109121
name: Test source code (pwsh, macos-latest)
@@ -128,6 +140,8 @@ jobs:
128140
Name: ${{ inputs.Name }}
129141
Path: ${{ inputs.Path }}
130142
TestType: SourceCode
143+
VerbosePreference: ${{ inputs.VerbosePreference }}
144+
DebugPreference: ${{ inputs.DebugPreference }}
131145

132146
TestSourceCode-pwsh-windows-latest:
133147
name: Test source code (pwsh, windows-latest)
@@ -152,6 +166,8 @@ jobs:
152166
Name: ${{ inputs.Name }}
153167
Path: ${{ inputs.Path }}
154168
TestType: SourceCode
169+
VerbosePreference: ${{ inputs.VerbosePreference }}
170+
DebugPreference: ${{ inputs.DebugPreference }}
155171

156172
BuildModule:
157173
name: Build module
@@ -212,6 +228,8 @@ jobs:
212228
Name: ${{ inputs.Name }}
213229
Path: ${{ inputs.ModulesOutputPath }}
214230
TestType: Module
231+
VerbosePreference: ${{ inputs.VerbosePreference }}
232+
DebugPreference: ${{ inputs.DebugPreference }}
215233

216234
- name: Status
217235
shell: pwsh
@@ -254,6 +272,8 @@ jobs:
254272
Name: ${{ inputs.Name }}
255273
Path: ${{ inputs.ModulesOutputPath }}
256274
TestType: Module
275+
VerbosePreference: ${{ inputs.VerbosePreference }}
276+
DebugPreference: ${{ inputs.DebugPreference }}
257277

258278
- name: Status
259279
shell: pwsh
@@ -296,6 +316,8 @@ jobs:
296316
Name: ${{ inputs.Name }}
297317
Path: ${{ inputs.ModulesOutputPath }}
298318
TestType: Module
319+
VerbosePreference: ${{ inputs.VerbosePreference }}
320+
DebugPreference: ${{ inputs.DebugPreference }}
299321

300322
- name: Status
301323
shell: pwsh

‎README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,12 @@ jobs:
7575
| `DocsOutputPath` | `string` | The path to the output directory for the documentation. | `false` | `outputs/docs` |
7676
| `PublishDocs` | `boolean` | Whether to publish the documentation using MkDocs and GitHub Pages. | `false` | `true` |
7777
| `SiteOutputPath` | `string` | The path to the output directory for the site. | `false` | `outputs/site` |
78-
| `SkipTests` | `string` | Defines what types of tests to skip. Allowed values are 'All', 'SourceCode', 'Module', 'None', 'macOS', 'Windows', 'Linux'. | false | `None` |
79-
| `TestProcess` | `boolean` | Whether to test the process. | false | `false` |
80-
| `Version` | `string` | The version of the 'GitHub' module to use. Defaults to latest version. | false | N/A |
81-
| `Prerelease` | `boolean` | Whether to use a prerelease version of the 'GitHub' module. | false | `false` |
78+
| `SkipTests` | `string` | Defines what types of tests to skip. Allowed values are 'All', 'SourceCode', 'Module', 'None', 'macOS', 'Windows', 'Linux'. | `false` | `None` |
79+
| `TestProcess` | `boolean` | Whether to test the process. | `false` | `false` |
80+
| `Version` | `string` | The version of the 'GitHub' module to use. Defaults to latest version. | `false` | N/A |
81+
| `Prerelease` | `boolean` | Whether to use a prerelease version of the 'GitHub' module. | `false` | `false` |
82+
| `VerbosePreference` | `string` | The preference for verbose output. Allowed values: 'SilentlyContinue', 'Stop', 'Continue', 'Inquire', 'Break', 'Ignore','Suspend'. | `false` | `SilentlyContinue` |
83+
| `DebugPreference` | `string` | The preference for debug output. Allowed values: 'SilentlyContinue', 'Stop', 'Continue', 'Inquire', 'Break', 'Ignore','Suspend'. | `false` | `SilentlyContinue` |
8284

8385
### Secrets
8486

0 commit comments

Comments
 (0)