Skip to content

Commit 3146283

Browse files
committed
fixes #101 - address markdown linting errors
1 parent 8b36dcc commit 3146283

File tree

9 files changed

+236
-65
lines changed

9 files changed

+236
-65
lines changed

docs/CHANGELOG.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,26 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [2.24.0]
8+
## [2.27.0]
99

1010
- Catesta template module changes
1111
- Updated all GitHub actions workflows from `actions/upload-artifact@v3` to `actions/upload-artifact@v4`
12-
- `Invoke-Formatter` now runs at the end of `Build` step for final cleanup
12+
- `*.build.ps1` Improvements:
13+
- `Invoke-Formatter` now runs at the end of `Build` step for final cleanup
14+
- Added new Markdown processing functionality to address two Markdown linting issues:
15+
- `MD022/blanks-around-headings`
16+
- `MD040/fenced-code-language`
1317
- CI/CD Changes:
1418
- Pester bumped from `5.6.1` to `5.7.1`
1519
- InvokeBuild bumped from `5.11.3` to `5.12.1`
1620
- PSScriptAnalyzer bumped from `1.22.0` to `1.23.0`
1721
- Catesta primary module changes
1822
- Updated GitHub actions workflows from `actions/upload-artifact@v3` to `actions/upload-artifact@v4`
19-
- `Invoke-Formatter` now runs at the end of `Build` step for final cleanup
23+
- `Catesta.build.ps1` Improvements:
24+
- `Invoke-Formatter` now runs at the end of `Build` step for final cleanup
25+
- Added new Markdown processing functionality to address two Markdown linting issues:
26+
- `MD022/blanks-around-headings`
27+
- `MD040/fenced-code-language`
2028
- Pester bumped from `5.6.1` to `5.7.1`
2129
- InvokeBuild bumped from `5.11.3` to `5.12.1`
2230
- PSScriptAnalyzer bumped from `1.22.0` to `1.23.0`

docs/Catesta.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Module Name: Catesta
33
Module Guid: 6796b193-9013-468a-b022-837749af2d06
44
Download Help Link: NA
5-
Help Version: 2.24.0
5+
Help Version: 2.27.0
66
Locale: en-US
77
---
88

@@ -16,5 +16,3 @@ Scaffolds a PowerShell module project for use with desired CICD platform for eas
1616

1717
### [New-VaultProject](New-VaultProject.md)
1818
Scaffolds a PowerShell SecretManagement vault project for use with desired CICD platform for easy cross platform PowerShell development.
19-
20-

docs/New-ModuleProject.md

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,18 @@ schema: 2.0.0
88
# New-ModuleProject
99

1010
## SYNOPSIS
11+
1112
Scaffolds a PowerShell module project for use with desired CICD platform for easy cross platform PowerShell development.
1213

1314
## SYNTAX
1415

15-
```
16+
```powershell
1617
New-ModuleProject [-DestinationPath] <String> [-ModuleParameters <Hashtable>] [-NoLogo] [-PassThru] [-Force]
1718
[-WhatIf] [-Confirm] [<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
22+
2123
Uses the Plaster framework to scaffold a PowerShell module that adheres to community best practices.
2224
Based on selections made, generates the files and configuration required to integrate with a variety of CI/CD platforms,
2325
including options for easy cross-platform verification on Windows, Linux, and MacOS.
@@ -31,15 +33,17 @@ If you pass in a full ModuleParameters set, Plaster will not prompt you for any
3133
## EXAMPLES
3234

3335
### EXAMPLE 1
34-
```
36+
37+
```powershell
3538
New-ModuleProject -DestinationPath $outPutPath
3639
```
3740

3841
Initiates Plaster template to scaffold a PowerShell module project with customizable CI/CD integration options.
3942
Choices made during scaffolding will result in a PowerShell project tailored to the chosen CI/CD platform, or a standard PowerShell module project with no CI/CD integration.
4043

4144
### EXAMPLE 2
42-
```
45+
46+
```powershell
4347
New-ModuleProject -DestinationPath $outPutPath -NoLogo
4448
```
4549

@@ -48,7 +52,8 @@ Choices made during scaffolding will result in a PowerShell project tailored to
4852
The Plaster logo will be suppressed and not shown.
4953

5054
### EXAMPLE 3
51-
```
55+
56+
```powershell
5257
New-ModuleProject -DestinationPath $outPutPath -PassThru
5358
```
5459

@@ -57,7 +62,8 @@ Choices made during scaffolding will result in a PowerShell project tailored to
5762
An object will be returned containing details of the Plaster template deployment.
5863

5964
### EXAMPLE 4
60-
```
65+
66+
```powershell
6167
$moduleParameters = @{
6268
ModuleName = 'ModuleName'
6369
Description = 'My awesome module is awesome'
@@ -77,7 +83,8 @@ Scaffolds a basic PowerShell module project with no additional extras.
7783
You just get a basic PowerShell module construct.
7884

7985
### EXAMPLE 5
80-
```
86+
87+
```powershell
8188
$moduleParameters = @{
8289
ModuleName = 'ModuleName'
8390
Description = 'My awesome module is awesome'
@@ -107,7 +114,8 @@ A full set of GitHub project supporting files is provided.
107114
The project is set up for integration with Read the Docs.
108115

109116
### EXAMPLE 6
110-
```
117+
118+
```powershell
111119
$moduleParameters = @{
112120
ModuleName = 'ModuleName'
113121
Description = 'My awesome module is awesome'
@@ -135,7 +143,8 @@ Scaffolds a PowerShell module project for integration with AWS CodeBuild with th
135143
A full set of GitHub project supporting files is provided.
136144

137145
### EXAMPLE 7
138-
```
146+
147+
```powershell
139148
$moduleParameters = @{
140149
ModuleName = 'ModuleName'
141150
Description = 'My awesome module is awesome'
@@ -162,7 +171,8 @@ Scaffolds a PowerShell module project for integration with Azure Pipelines with
162171
No repository supporting files are included.
163172

164173
### EXAMPLE 8
165-
```
174+
175+
```powershell
166176
$moduleParameters = @{
167177
ModuleName = 'ModuleName'
168178
Description = 'My awesome module is awesome'
@@ -190,7 +200,8 @@ Scaffolds a PowerShell module project for integration with Appveyor with the pro
190200
No repository supporting files are included.
191201

192202
### EXAMPLE 9
193-
```
203+
204+
```powershell
194205
$moduleParameters = @{
195206
ModuleName = 'ModuleName'
196207
Description = 'My awesome module is awesome'
@@ -217,7 +228,8 @@ Scaffolds a PowerShell module project for integration with Bitbucket Pipelines w
217228
A full set of repository supporting files are included.
218229

219230
### EXAMPLE 10
220-
```
231+
232+
```powershell
221233
$moduleParameters = @{
222234
ModuleName = 'ModuleName'
223235
Description = 'My awesome module is awesome'
@@ -243,12 +255,13 @@ New-ModuleProject -ModuleParameters $moduleParameters -DestinationPath $outPutPa
243255
```
244256

245257
Scaffolds a PowerShell module project for integration with GitLab CI/CD Pipelines with the project code stored on GitLab.
246-
A full set of repository supporting files are included.
258+
A full set of repository supporting files are included.
247259
The project is set up for integration with Read the Docs.
248260

249261
## PARAMETERS
250262

251263
### -DestinationPath
264+
252265
File path where PowerShell Module project will be created
253266

254267
```yaml
@@ -264,6 +277,7 @@ Accept wildcard characters: False
264277
```
265278
266279
### -ModuleParameters
280+
267281
Provide all Plaster decisions inside a Hashtable.
268282
If any decision choice is not provided, Plaster will still prompt you for a decision.
269283
See NOTES for additional limitations.
@@ -281,6 +295,7 @@ Accept wildcard characters: False
281295
```
282296
283297
### -NoLogo
298+
284299
Suppresses the display of the Plaster logo.
285300
286301
```yaml
@@ -296,6 +311,7 @@ Accept wildcard characters: False
296311
```
297312
298313
### -PassThru
314+
299315
Returns an object containing details of Plaster template deployment.
300316
301317
```yaml
@@ -311,6 +327,7 @@ Accept wildcard characters: False
311327
```
312328
313329
### -Force
330+
314331
Skip Confirmation
315332
316333
```yaml
@@ -326,6 +343,7 @@ Accept wildcard characters: False
326343
```
327344
328345
### -WhatIf
346+
329347
Shows what would happen if the cmdlet runs.
330348
The cmdlet is not run.
331349
@@ -342,6 +360,7 @@ Accept wildcard characters: False
342360
```
343361
344362
### -Confirm
363+
345364
Prompts you for confirmation before running the cmdlet.
346365
347366
```yaml
@@ -357,15 +376,18 @@ Accept wildcard characters: False
357376
```
358377
359378
### CommonParameters
360-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction.
379+
380+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction.
361381
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
362382
363383
## INPUTS
364384
365385
## OUTPUTS
366386
367387
### System.Management.Automation.PSCustomObject
388+
368389
## NOTES
390+
369391
Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/
370392
371393
Catesta Plaster templates have dynamic choices.

0 commit comments

Comments
 (0)