v2.0.0: JSON manifests, modular refactor, PS7 cross-platform, modernized build/test

.github/workflows/PesterReports.yml

@@ -1,14 +1,16 @@
+# spell-checker:ignore potatoqualitee psdepend psmodulecache
 name: PesterReports
 # Controls when the action will run.
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
     branches: [ master ]
   pull_request:
-    branches: [ master ]
-
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
+permissions:
+  checks: write
+  pull-requests: write
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
@@ -21,40 +23,49 @@ jobs:
         os: [ubuntu-latest, windows-latest, macOS-latest]
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-      - uses: actions/checkout@v2
-      # Setup Build Helpers
-      - name: SetupBuildHelpers
+      - uses: actions/checkout@v4
+      - name: Install and cache PSDepend
+        id: psdepend
+        uses: potatoqualitee/psmodulecache@v6.2.1
+        with:
+          modules-to-cache: PSDepend:0.3.8
+      - name: Determine modules to cache
         shell: pwsh
+        id: modules-to-cache
         run: |
-          Install-Module BuildHelpers -Scope CurrentUser -Force | Out-Null
-          Install-Module PowerShellBuild -Scope CurrentUser -Force | Out-Null
-          Install-Module PSScriptAnalyzer -Scope CurrentUser -Force | Out-Null
-          Install-Module platyPS -Scope CurrentUser -Force | Out-Null
+          $dependencies = Get-Dependency
+          $f = $dependencies | ?{ $_.DependencyType -eq 'PSGalleryModule' } | %{ "{0}:{1}" -F $_.DependencyName, $_.Version}
+          Write-Output "::set-output name=ModulesToCache::$($f -join ', ')"
+      - name: Install and cache PowerShell modules
+        id: psmodulecache
+        uses: potatoqualitee/psmodulecache@v6.2.1
+        with:
+          modules-to-cache: ${{ steps.modules-to-cache.outputs.ModulesToCache }}
+          shell: pwsh
       - name: Test
         shell: pwsh
-        run: |
-          ./build.ps1 -Task Test
+        run: ./build.ps1 -Task Test
       - name: Upload Unit Test Results
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4.6.2
         with:
           name: Unit Test Results (OS ${{ matrix.os }})
-          path: ./tests/Out/testResults.xml
+          path: ./tests/out/testResults.xml
 
   publish-test-results:
     name: "Publish Unit Tests Results"
     needs: test
     runs-on: ubuntu-latest
     # the test job might be skipped, we don't need to run this job then
-    if: success() || failure()
+    if: (!cancelled())
 
     steps:
       - name: Download Artifacts
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4.3.0
         with:
           path: artifacts
 
       - name: Publish Unit Test Results
-        uses: EnricoMi/publish-unit-test-result-action@v1
+        uses: EnricoMi/publish-unit-test-result-action@v2.20.0
         with:
           files: artifacts/**/*.xml

.github/workflows/publish.yaml

@@ -1,34 +1,24 @@
 name: Publish Module
 on:
-  pull_request:
-    branches: [ master ]
+  # Only on workflow dispatch, so that we can control when to publish.
   workflow_dispatch:
 jobs:
   build:
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Install and cache PowerShell modules
-        id: psmodulecache
-        uses: potatoqualitee/psmodulecache@v5.1
+      - name: ⚡ ModuleFast with Specification
+        uses: JustinGrote/ModuleFast-action@v0.0.1
         with:
-          modules-to-cache: BuildHelpers, PowerShellBuild, psake, PSScriptAnalyzer, platyPS
-      - shell: pwsh
-        # Give an id to the step, so we can reference it later
-        id: check_if_versions_bumped
-        run: |
-          [version]$GalleryVersion = Get-NextNugetPackageVersion -Name Plaster -ErrorAction Stop
-          [version]$GithubVersion = Get-MetaData -Path ./Plaster/Plaster.psd1 -PropertyName ModuleVersion -ErrorAction Stop
-          $bumped = $GithubVersion -ge $GalleryVersion
-
-          # Set the output named "version_bumped"
-          Write-Host "::set-output name=version_bumped::$bumped"
-
-      # Only publish (from master) if versions
+          specification: |
+            BuildHelpers
+            PowerShellBuild
+            psake
+            PSScriptAnalyzer
+            platyPS
       - name: Build and publish
-        if: steps.check_if_versions_bumped.outputs.version_bumped == 'True'
         env:
           PSGALLERY_API_KEY: ${{ secrets.GALLERY_KEY }}
         shell: pwsh
         run: |
-          ./build.ps1 -Task Publish
+          ./build.ps1 -Task Publish -Bootstrap

.markdownlint.json

@@ -0,0 +1,5 @@
+{
+  "MD024": {
+    "siblings_only": true
+  }
+}

.vscode/settings.json

@@ -2,14 +2,20 @@
     //-------- Files configuration --------
     // When enabled, will trim trailing whitespace when you save a file.
     "files.trimTrailingWhitespace": true,
+    "files.insertFinalNewline": true,
+    "editor.insertSpaces": true,
+    "editor.tabSize": 4,
+    // -------- Search configuration --------
+    // Exclude the Output folder from search results.
     "search.exclude": {
-        "Release": true
+        "Output/**": true
     },
     //-------- PowerShell Configuration --------
     // Use a custom PowerShell Script Analyzer settings file for this workspace.
     // Relative paths for this setting are always relative to the workspace root dir.
     "powershell.scriptAnalysis.settingsPath": "ScriptAnalyzerSettings.psd1",
     //----------Code Formatting ----------------
     "powershell.codeFormatting.preset": "OTBS",
-    "editor.formatOnSave": true
-}
+    "editor.formatOnSave": true,
+    "powershell.scriptAnalysis.enable": true
+}

.vscode/tasks.json

@@ -2,45 +2,60 @@
     // See https://go.microsoft.com/fwlink/?LinkId=733558
     // for the documentation about the tasks.json format
     "version": "2.0.0",
-
     // Start PowerShell
     "windows": {
         "options": {
             "shell": {
-                "executable": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe",
-                "args": [ "-NoProfile", "-ExecutionPolicy", "Bypass", "-Command" ]
+                "executable": "pwsh.exe",
+                "args": [
+                    "-NoProfile",
+                    "-ExecutionPolicy",
+                    "Bypass",
+                    "-Command"
+                ]
             }
         }
     },
     "linux": {
         "options": {
             "shell": {
                 "executable": "/usr/bin/pwsh",
-                "args": [ "-NoProfile", "-Command" ]
+                "args": [
+                    "-NoProfile",
+                    "-Command"
+                ]
             }
         }
     },
     "osx": {
         "options": {
             "shell": {
                 "executable": "/usr/local/bin/pwsh",
-                "args": [ "-NoProfile", "-Command" ]
+                "args": [
+                    "-NoProfile",
+                    "-Command"
+                ]
             }
         }
     },
-
     // Associate with test task runner
     "tasks": [
+        {
+            "label": "Bootstrap",
+            "type": "shell",
+            "command": "./build.ps1 -Task Init -Bootstrap",
+            "problemMatcher": []
+        },
         {
             "label": "Clean",
             "type": "shell",
-            "command": "Invoke-psake build.psake.ps1 -taskList Clean",
+            "command": "./build.ps1 -Task Clean",
             "problemMatcher": []
         },
         {
             "label": "Build",
             "type": "shell",
-            "command": "Invoke-psake build.psake.ps1 -taskList Build",
+            "command": "./build.ps1 -Task Build",
             "group": {
                 "kind": "build",
                 "isDefault": true
@@ -50,36 +65,38 @@
         {
             "label": "BuildHelp",
             "type": "shell",
-            "command": "Invoke-psake build.psake.ps1 -taskList BuildHelp",
+            "command": "./build.ps1 -Task BuildHelp",
             "problemMatcher": []
         },
         {
             "label": "Analyze",
             "type": "shell",
-            "command": "Invoke-psake build.psake.ps1 -taskList Analyze",
+            "command": "./build.ps1 -Task Analyze",
             "problemMatcher": []
         },
         {
             "label": "Install",
             "type": "shell",
-            "command": "Invoke-psake build.psake.ps1 -taskList Install",
+            "command": "./build.ps1 -Task Install",
             "problemMatcher": []
         },
         {
             "label": "Publish",
             "type": "shell",
-            "command": "Invoke-psake build.psake.ps1 -taskList Publish",
+            "command": "./build.ps1 -Task Publish",
             "problemMatcher": []
         },
         {
             "label": "Test",
             "type": "shell",
-            "command": "Invoke-Pester -PesterOption @{IncludeVSCodeMarker=$true}",
+            "command": "./build.ps1 -Task Test",
             "group": {
                 "kind": "test",
                 "isDefault": true
             },
-            "problemMatcher": [ "$pester" ]
+            "problemMatcher": [
+                "$pester"
+            ]
         }
-	]
-}
+    ]
+}