Merge pull request #104 from techthoughts2/Enhancements

Enhancements

Author: techthoughts2

.github/workflows/wf_Linux.yml

@@ -41,13 +41,13 @@ jobs:
       shell: pwsh
       run: Invoke-Build -File .\src\Catesta.build.ps1
     - name: Upload pester results
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: pester-results
         path: ./src/Artifacts/testOutput
         if-no-files-found: warn
     - name: Upload zip module archive build
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: zip-archive
         path: ./src/Archive

.github/workflows/wf_MacOS.yml

@@ -41,13 +41,13 @@ jobs:
       shell: pwsh
       run: Invoke-Build -File .\src\Catesta.build.ps1
     - name: Upload pester results
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: pester-results
         path: ./src/Artifacts/testOutput
         if-no-files-found: warn
     - name: Upload zip module archive build
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: zip-archive
         path: ./src/Archive

.github/workflows/wf_Windows.yml

@@ -41,13 +41,13 @@ jobs:
       shell: powershell
       run: Invoke-Build -File .\src\Catesta.build.ps1
     - name: Upload pester results
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: pester-results
         path: .\src\Artifacts\testOutput
         if-no-files-found: warn
     - name: Upload zip module archive build
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: zip-archive
         path: .\src\Archive

.github/workflows/wf_Windows_Core.yml

@@ -41,13 +41,13 @@ jobs:
       shell: pwsh
       run: Invoke-Build -File .\src\Catesta.build.ps1
     - name: Upload pester results
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: pester-results
         path: .\src\Artifacts\testOutput
         if-no-files-found: warn
     - name: Upload zip module archive build
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: zip-archive
         path: .\src\Archive

actions_bootstrap.ps1

@@ -16,17 +16,17 @@ $modulesToInstall = New-Object System.Collections.Generic.List[object]
 # https://github.com/pester/Pester
 [void]$modulesToInstall.Add(([PSCustomObject]@{
             ModuleName    = 'Pester'
-            ModuleVersion = '5.6.1'
+            ModuleVersion = '5.7.1'
         }))
 # https://github.com/nightroman/Invoke-Build
 [void]$modulesToInstall.Add(([PSCustomObject]@{
             ModuleName    = 'InvokeBuild'
-            ModuleVersion = '5.11.3'
+            ModuleVersion = '5.12.1'
         }))
 # https://github.com/PowerShell/PSScriptAnalyzer
 [void]$modulesToInstall.Add(([PSCustomObject]@{
             ModuleName    = 'PSScriptAnalyzer'
-            ModuleVersion = '1.22.0'
+            ModuleVersion = '1.23.0'
         }))
 # https://github.com/PowerShell/platyPS
 # older version used due to: https://github.com/PowerShell/platyPS/issues/457

docs/CHANGELOG.md

@@ -5,6 +5,40 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.27.0]
+
+- Catesta template module changes
+    - Updated all GitHub actions workflows from `actions/upload-artifact@v3` to `actions/upload-artifact@v4`
+    - `*.build.ps1` Improvements:
+        - `Invoke-Formatter` now runs at the end of `Build` step for final cleanup
+        - Added new Markdown processing functionality to address two Markdown linting issues:
+            - `MD022/blanks-around-headings`
+            - `MD040/fenced-code-language`
+        - Added more detailed error output to `ImportModuleManifest`
+    - CI/CD Changes:
+        - Pester bumped from `5.6.1` to `5.7.1`
+        - InvokeBuild bumped from `5.11.3` to `5.12.1`
+        - PSScriptAnalyzer bumped from `1.22.0` to `1.23.0`
+- Catesta primary module changes
+    - Updated GitHub actions workflows from `actions/upload-artifact@v3` to `actions/upload-artifact@v4`
+    - `Catesta.build.ps1` Improvements:
+        - `Invoke-Formatter` now runs at the end of `Build` step for final cleanup
+        - Added new Markdown processing functionality to address two Markdown linting issues:
+            - `MD022/blanks-around-headings`
+            - `MD040/fenced-code-language`
+        - Added more detailed error output to `ImportModuleManifest`
+    - Pester bumped from `5.6.1` to `5.7.1`
+    - InvokeBuild bumped from `5.11.3` to `5.12.1`
+    - PSScriptAnalyzer bumped from `1.22.0` to `1.23.0`
+
+## [2.22.2]
+
+- Catesta template module changes
+    - Added PSScriptAnalyzer suppression rule to `MarkdownRepair.ps1`
+- Catesta primary module changes
+    - Addressed bug in `Catesta.build.ps1` where in certain circumstances PSScriptAnalyzer violations were not being properly detected
+    - Added PSScriptAnalyzer suppression rule to `MarkdownRepair.ps1`
+
 ## [2.22.0]
 
 - Catesta template module changes

docs/Catesta.md

@@ -2,7 +2,7 @@
 Module Name: Catesta
 Module Guid: 6796b193-9013-468a-b022-837749af2d06
 Download Help Link: NA
-Help Version: 2.22.0
+Help Version: 2.27.0
 Locale: en-US
 ---
 
@@ -16,5 +16,3 @@ Scaffolds a PowerShell module project for use with desired CICD platform for eas
 
 ### [New-VaultProject](New-VaultProject.md)
 Scaffolds a PowerShell SecretManagement vault project for use with desired CICD platform for easy cross platform PowerShell development.
-
-

docs/New-ModuleProject.md

@@ -8,16 +8,18 @@ schema: 2.0.0
 # New-ModuleProject
 
 ## SYNOPSIS
+
 Scaffolds a PowerShell module project for use with desired CICD platform for easy cross platform PowerShell development.
 
 ## SYNTAX
 
-```
+```powershell
 New-ModuleProject [-DestinationPath] <String> [-ModuleParameters <Hashtable>] [-NoLogo] [-PassThru] [-Force]
  [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
+
 Uses the Plaster framework to scaffold a PowerShell module that adheres to community best practices.
 Based on selections made, generates the files and configuration required to integrate with a variety of CI/CD platforms,
 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
 ## EXAMPLES
 
 ### EXAMPLE 1
-```
+
+```powershell
 New-ModuleProject -DestinationPath $outPutPath
 ```
 
 Initiates Plaster template to scaffold a PowerShell module project with customizable CI/CD integration options.
 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.
 
 ### EXAMPLE 2
-```
+
+```powershell
 New-ModuleProject -DestinationPath $outPutPath -NoLogo
 ```
 
@@ -48,7 +52,8 @@ Choices made during scaffolding will result in a PowerShell project tailored to
 The Plaster logo will be suppressed and not shown.
 
 ### EXAMPLE 3
-```
+
+```powershell
 New-ModuleProject -DestinationPath $outPutPath -PassThru
 ```
 
@@ -57,7 +62,8 @@ Choices made during scaffolding will result in a PowerShell project tailored to
 An object will be returned containing details of the Plaster template deployment.
 
 ### EXAMPLE 4
-```
+
+```powershell
 $moduleParameters = @{
     ModuleName  = 'ModuleName'
     Description = 'My awesome module is awesome'
@@ -77,7 +83,8 @@ Scaffolds a basic PowerShell module project with no additional extras.
 You just get a basic PowerShell module construct.
 
 ### EXAMPLE 5
-```
+
+```powershell
 $moduleParameters = @{
     ModuleName     = 'ModuleName'
     Description    = 'My awesome module is awesome'
@@ -107,7 +114,8 @@ A full set of GitHub project supporting files is provided.
 The project is set up for integration with Read the Docs.
 
 ### EXAMPLE 6
-```
+
+```powershell
 $moduleParameters = @{
     ModuleName  = 'ModuleName'
     Description = 'My awesome module is awesome'
@@ -135,7 +143,8 @@ Scaffolds a PowerShell module project for integration with AWS CodeBuild with th
 A full set of GitHub project supporting files is provided.
 
 ### EXAMPLE 7
-```
+
+```powershell
 $moduleParameters = @{
     ModuleName   = 'ModuleName'
     Description  = 'My awesome module is awesome'
@@ -162,7 +171,8 @@ Scaffolds a PowerShell module project for integration with Azure Pipelines with
 No repository supporting files are included.
 
 ### EXAMPLE 8
-```
+
+```powershell
 $moduleParameters = @{
     ModuleName      = 'ModuleName'
     Description     = 'My awesome module is awesome'
@@ -190,7 +200,8 @@ Scaffolds a PowerShell module project for integration with Appveyor with the pro
 No repository supporting files are included.
 
 ### EXAMPLE 9
-```
+
+```powershell
 $moduleParameters = @{
     ModuleName  = 'ModuleName'
     Description = 'My awesome module is awesome'
@@ -217,7 +228,8 @@ Scaffolds a PowerShell module project for integration with Bitbucket Pipelines w
 A full set of repository supporting files are included.
 
 ### EXAMPLE 10
-```
+
+```powershell
 $moduleParameters = @{
     ModuleName    = 'ModuleName'
     Description   = 'My awesome module is awesome'
@@ -249,6 +261,7 @@ The project is set up for integration with Read the Docs.
 ## PARAMETERS
 
 ### -DestinationPath
+
 File path where PowerShell Module project will be created
 
 ```yaml
@@ -264,6 +277,7 @@ Accept wildcard characters: False
 ```
 
 ### -ModuleParameters
+
 Provide all Plaster decisions inside a Hashtable.
 If any decision choice is not provided, Plaster will still prompt you for a decision.
 See NOTES for additional limitations.
@@ -281,6 +295,7 @@ Accept wildcard characters: False
 ```
 
 ### -NoLogo
+
 Suppresses the display of the Plaster logo.
 
 ```yaml
@@ -296,6 +311,7 @@ Accept wildcard characters: False
 ```
 
 ### -PassThru
+
 Returns an object containing details of Plaster template deployment.
 
 ```yaml
@@ -311,6 +327,7 @@ Accept wildcard characters: False
 ```
 
 ### -Force
+
 Skip Confirmation
 
 ```yaml
@@ -326,6 +343,7 @@ Accept wildcard characters: False
 ```
 
 ### -WhatIf
+
 Shows what would happen if the cmdlet runs.
 The cmdlet is not run.
 
@@ -342,6 +360,7 @@ Accept wildcard characters: False
 ```
 
 ### -Confirm
+
 Prompts you for confirmation before running the cmdlet.
 
 ```yaml
@@ -357,6 +376,7 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
+
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. 
 For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
 
@@ -365,7 +385,9 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink
 ## OUTPUTS
 
 ### System.Management.Automation.PSCustomObject
+
 ## NOTES
+
 Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/
 
 Catesta Plaster templates have dynamic choices.