Merge branch 'main' into bewhite/repo-config

Author: BernieWhite

.azure-pipelines/azure-pipelines.yaml

@@ -2,23 +2,19 @@
 # CI pipeline for PSRule
 
 variables:
-  version: '2.1.0'
+  version: '2.5.0'
   buildConfiguration: 'Release'
   disable.coverage.autogenerate: 'true'
-  imageName: 'ubuntu-20.04'
+  imageName: 'ubuntu-22.04'
 
- # Use build number format, i.e. 2.1.0-B2203001
+ # Use build number format, i.e. 2.5.0-B2203001
 name: $(version)-B$(date:yyMM)$(rev:rrr)
 
 trigger:
   branches:
     include:
     - 'main'
     - 'release/*'
-  # tags:
-  #   include:
-  #   - 'v1.*'
-  #   - 'v2.*'
 
 pr:
   branches:
@@ -115,7 +111,7 @@ stages:
 
   - job: Secret_Scan
     pool:
-      vmImage: 'windows-2019'
+      vmImage: 'windows-2022'
     displayName: Secret scan
 
     steps:
@@ -142,84 +138,48 @@ stages:
 
   - template: jobs/test.yaml
     parameters:
-      name: ubuntu_20_04_coverage
-      imageName: 'ubuntu-20.04'
+      name: ubuntu_22_04_coverage
+      imageName: 'ubuntu-22.04'
       displayName: 'PowerShell coverage'
       coverage: 'true'
       publishResults: 'false'
 
   - template: jobs/test.yaml
     parameters:
-      name: macOS_10_15
-      displayName: 'PowerShell 7.2 - macOS-10.15'
-      imageName: 'macOS-10.15'
+      name: macOS_11
+      displayName: 'PowerShell 7.2 - macOS-11'
+      imageName: 'macOS-11'
 
   - template: jobs/test.yaml
     parameters:
-      name: ps_5_1_windows_2019
-      displayName: 'PowerShell 5.1 - Windows 2019'
-      imageName: 'windows-2019'
+      name: ps_5_1_windows_2022
+      displayName: 'PowerShell 5.1 - Windows 2022'
+      imageName: 'windows-2022'
       pwsh: 'false'
 
   - template: jobs/test.yaml
     parameters:
-      name: ps_7_2_windows_2019
-      displayName: 'PowerShell 7.2 - Windows 2019'
-      imageName: 'windows-2019'
+      name: ps_7_2_windows_2022
+      displayName: 'PowerShell 7.2 - Windows 2022'
+      imageName: 'windows-2022'
+
+  # - template: jobs/testContainer.yaml
+  #   parameters:
+  #     name: alpine_3_14
+  #     displayName: 'PowerShell 7.2 - alpine-3.14'
+  #     imageName: mcr.microsoft.com/powershell/test-deps
+  #     imageTag: alpine-3.14
 
   - template: jobs/testContainer.yaml
     parameters:
-      name: alpine_3_14
-      displayName: 'PowerShell 7.2 - alpine-3.14'
-      imageName: mcr.microsoft.com/powershell/test-deps
-      imageTag: alpine-3.14
+      name: ps_7_2_ubuntu_22_04
+      displayName: 'PowerShell 7.2 - ubuntu-22.04'
+      imageName: mcr.microsoft.com/powershell
+      imageTag: 7.2-ubuntu-22.04
 
   - template: jobs/testContainer.yaml
     parameters:
-      name: ps_7_2_ubuntu_20_04
-      displayName: 'PowerShell 7.2 - ubuntu-20.04'
+      name: ps_7_3_ubuntu_22_04
+      displayName: 'PowerShell 7.3 - ubuntu-22.04'
       imageName: mcr.microsoft.com/powershell
-      imageTag: 7.2.2-ubuntu-20.04
-
-# Release pipeline
-# - stage: Release
-#   displayName: Release
-#   dependsOn: [ 'Test', 'Analysis' ]
-#   condition: and(succeeded(), or(startsWith(variables['Build.SourceBranch'], 'refs/tags/v1.'), startsWith(variables['Build.SourceBranch'], 'refs/tags/v2.')))
-#   jobs:
-#   - job:
-#     displayName: Live
-#     pool:
-#       vmImage: $(imageName)
-#     variables:
-#       isPreRelease: $[contains(variables['Build.SourceBranchName'], '-B')]
-#     steps:
-
-#     # Download module from build
-#     - task: DownloadPipelineArtifact@2
-#       displayName: 'Download module'
-#       inputs:
-#         artifact: PSRule
-#         path: $(Build.SourcesDirectory)/out/modules/PSRule
-
-#     # Install pipeline dependencies
-#     - powershell: ./.azure-pipelines/pipeline-deps.ps1
-#       displayName: 'Install dependencies'
-
-#     # Install pipeline dependencies and build module
-#     - powershell: Invoke-Build Release -ApiKey $(apiKey)
-#       displayName: 'Publish module'
-
-#     # Update GitHub release
-#     - task: GitHubRelease@1
-#       displayName: 'GitHub release'
-#       inputs:
-#         gitHubConnection: 'AzureDevOps-PSRule'
-#         repositoryName: '$(Build.Repository.Name)'
-#         action: edit
-#         tag: '$(Build.SourceBranchName)'
-#         releaseNotesSource: inline
-#         releaseNotesInline: 'See [change log](https://github.com/Microsoft/PSRule/blob/main/CHANGELOG.md)'
-#         assetUploadMode: replace
-#         addChangeLog: false
-#         isPreRelease: $(isPreRelease)
+      imageTag: 7.3-ubuntu-22.04

.devcontainer/Dockerfile

@@ -0,0 +1,10 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+# Visual Studio Code image with .NET
+
+# NOTE:
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/dotnet/.devcontainer/base.Dockerfile
+
+ARG VARIANT="6.0-bullseye-slim"
+FROM mcr.microsoft.com/vscode/devcontainers/dotnet:0-${VARIANT}

.devcontainer/container-build.ps1

@@ -5,6 +5,7 @@
 # This is run during container creation.
 
 # Install Python 3 dependencies
+sudo apt install python3-pip -y
 sudo python3 -m pip install --upgrade pip
 sudo python3 -m pip install wheel
 
@@ -19,3 +20,6 @@ if ($Null -eq (Get-InstalledModule -Name PowerShellGet -MinimumVersion 2.2.1 -Er
 if ($Null -eq (Get-InstalledModule -Name InvokeBuild -MinimumVersion 5.4.0 -ErrorAction Ignore)) {
     Install-Module InvokeBuild -MinimumVersion 5.4.0 -Scope CurrentUser -Force;
 }
+
+Import-Module ./scripts/dependencies.psm1;
+Install-Dependencies -Dev;

.devcontainer/container-start.ps1

@@ -5,7 +5,7 @@
 # This is run during container startup.
 
 # Install Python packages
-# pip install -r requirements-docs.txt
+pip install -r requirements-docs.txt
 
 # Restore .NET packages
 dotnet restore

.devcontainer/devcontainer.json

@@ -1,25 +1,33 @@
 {
-    "name": "PSRule dev",
-    "settings": {
+  "$schema": "https://raw.githubusercontent.com/devcontainers/spec/main/schemas/devContainer.schema.json",
+  "name": "PSRule dev",
+  "customizations": {
+    "vscode": {
+      "settings": {
         "terminal.integrated.defaultProfile.linux": "pwsh",
         "terminal.integrated.profiles.linux": {
-            "pwsh": {
-                "path": "/bin/pwsh"
-            }
+          "pwsh": {
+            "path": "/opt/microsoft/powershell/7/pwsh"
+          }
         }
-    },
-    "extensions": [
-        "ms-azure-devops.azure-pipelines",
-        "davidanson.vscode-markdownlint",
-        "bewhite.psrule-vscode-preview",
+      },
+      "extensions": [
         "ms-dotnettools.csharp",
-        "eamodio.gitlens",
-        "github.vscode-pull-request-github",
-        "streetsidesoftware.code-spell-checker"
-    ],
-    "features": {
-        "github-cli": "latest"
-    },
-    "onCreateCommand": "/bin/pwsh -f .devcontainer/container-build.ps1",
-    "postStartCommand": "/bin/pwsh -f .devcontainer/container-start.ps1"
+        "bewhite.psrule-vscode-preview"
+      ]
+    }
+  },
+  "features": {
+    "github-cli": "latest",
+    "powershell": "latest"
+  },
+  "onCreateCommand": "/opt/microsoft/powershell/7/pwsh -f .devcontainer/container-build.ps1",
+  "postStartCommand": "/opt/microsoft/powershell/7/pwsh -f .devcontainer/container-start.ps1",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "args": {
+      "VARIANT": "6.0-bullseye-slim"
+    }
+  },
+  "remoteUser": "vscode"
 }

.editorconfig

@@ -7,6 +7,7 @@ root = true
 [*]
 charset = utf-8
 indent_style = space
+insert_final_newline = true
 
 # Source code
 [*.{cs,ps1,psd1,psm1}]
@@ -44,4 +45,27 @@ csharp_prefer_simple_default_expression = true:suggestion
 # Prefer "var" everywhere
 csharp_style_var_for_built_in_types = true:suggestion
 csharp_style_var_when_type_is_apparent = true:suggestion
-csharp_style_var_elsewhere = true:suggestion
+csharp_style_var_elsewhere = true:suggestion
+
+# Define the 'private_fields' symbol group:
+dotnet_naming_symbols.private_fields.applicable_kinds = field
+dotnet_naming_symbols.private_fields.applicable_accessibilities = private
+
+# Define the 'private_static_fields' symbol group
+dotnet_naming_symbols.private_static_fields.applicable_kinds = field
+dotnet_naming_symbols.private_static_fields.applicable_accessibilities = private
+dotnet_naming_symbols.private_static_fields.required_modifiers = static
+
+# Define the 'underscored' naming style
+dotnet_naming_style.underscored.capitalization = pascal_case
+dotnet_naming_style.underscored.required_prefix = _
+
+# Private instance fields must use pascal case with a leading '_'
+dotnet_naming_rule.private_fields_underscored.symbols = private_fields
+dotnet_naming_rule.private_fields_underscored.style = underscored
+dotnet_naming_rule.private_fields_underscored.severity = error
+
+# Exclude private static fields from underscored style
+dotnet_naming_rule.private_static_fields_none.symbols = private_static_fields
+dotnet_naming_rule.private_static_fields_none.style = underscored
+dotnet_naming_rule.private_static_fields_none.severity = none

.github/ISSUE_TEMPLATE/bug_report.md

@@ -30,7 +30,7 @@ Steps to reproduce the issue:
 **Module in use and version:**
 
 - Module: PSRule
-- Version: **[e.g. 2.0.0]**
+- Version: **[e.g. 2.4.0]**
 
 Captured output from `$PSVersionTable`:
 

.github/workflows/analyze.yaml

@@ -19,6 +19,8 @@ on:
   - cron: '24 22 * * 0' # At 10:24 PM, on Sunday each week
   workflow_dispatch:
 
+permissions: {}
+
 jobs:
   oss:
     name: Analyze with PSRule

.github/workflows/dependencies.yaml

@@ -14,6 +14,8 @@ on:
 env:
   WORKING_BRANCH: dependencies/powershell-bump
 
+permissions: {}
+
 jobs:
   dependencies:
     name: Bump dependencies

.github/workflows/docs.yaml

@@ -12,6 +12,8 @@ on:
     - main
   workflow_dispatch:
 
+permissions: {}
+
 jobs:
   deploy:
     name: Publish docs