Add workflow for running ScriptAnalyzer (#236464)

Author: Trenly

.github/workflows/scriptAnalyzer.yaml

@@ -0,0 +1,40 @@
+name: PSScriptAnalyzer
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - "**/*.ps1"
+  push:
+    paths:
+      - "**/*.ps1"
+
+permissions:
+  contents: read # Needed to check out the code
+  pull-requests: read # Needed to read pull request details
+
+jobs:
+  analyze:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install PSScriptAnalyzer
+        run: |
+          Install-Module -Name PSScriptAnalyzer -Force -SkipPublisherCheck -Scope CurrentUser
+      - name: Run PSScriptAnalyzer
+        run: |
+          # Run PSScriptAnalyzer on all PowerShell scripts
+          $results = Get-ChildItem -Recurse -Filter *.ps1 | Invoke-ScriptAnalyzer
+          if ($results) {
+            Write-Output $results | Format-List -GroupBy ScriptName
+          }
+
+          # If errors are found, exit with a non-zero exit code to fail the job
+          if ($results.where({$_.Severity-eq 'Error'})) {
+            Write-Host "Found script issues (errors)."
+            exit 1  # Exit with a non-zero status to fail the job
+          } else {
+            Write-Host "No blocking detections."
+          }

Tools/YamlCreate.ps1

@@ -1635,8 +1635,6 @@ Function Read-InstallerMetadataValue {
 # If a key does not exist, it sets the value to a special character to be removed / commented later
 # Returns the result as a new object
 Function Restore-YamlKeyOrder {
-  [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'InputObject', Justification = 'The variable is used inside a conditional but ScriptAnalyser does not recognize the scope')]
-  [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'NoComments', Justification = 'The variable is used inside a conditional but ScriptAnalyser does not recognize the scope')]
   Param
   (
     [Parameter(Mandatory = $true, Position = 0)]