fix: comprehensive workflow and build reliability fixes (#411)

vicperdana · web-flow · commit 9cbc765ba25e · 2026-04-22T22:23:29.000+10:00
Resolves CI failures and supply-chain/release issues across the three package pipelines (psdocs, psdocs-azure, vscode-extension).

Build &amp; bootstrap

 - Install missing InvokeBuild in build-psdocs; trust PSGallery non-interactively; add .NET
  7.0 (PSDocs targets net7.0)
 - Cross-platform PSModulePath via [IO.Path]::PathSeparator; fix hashFiles glob pattern; expand path filter to include root build files

Release workflow

 - Pass tag version through to Invoke-Build (was silently defaulting to
  0.0.1)
 - Drop conflicting --generate-notes flag from gh release create
 - Use repo-root CHANGELOG.md for psdocs-azure

VS Code extension

 - Migrate to ESLint 9 flat config (eslint.config.mjs); add typescript-eslint + @eslint/js; remove deprecated --ext flag and legacy .eslintrc.json
 - Relax presets to preserve original rule set (no behavior change vs. subtree)
 - Pin @types/vscode to ~1.89.0 to match engines.vscode (vsce requirement)
 - Fix VSCE_PAT gate to use secrets context (step env not available at if: time)
 - Regenerate package-lock.json

Hardening &amp; cleanup

 - Pin microsoft/ps-docs action to SHA (supply-chain)
 - Correct site_url in mkdocs.yml
 - Delete inert packages/psdocs/.github/workflows/build.yaml (GitHub only reads root .github/workflows/)

Tests

 - Regenerate example template READMEs to match generator output (drop hardcoded Template-Pass badge not produced by Azure.Template.Doc.ps1)
 - Remove @types/glob (conflicts with glob@11's bundled types)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -35,9 +35,9 @@ jobs:
             BASE_SHA="${{ github.event.pull_request.base.sha }}"
           fi
           CHANGED=$(git diff --name-only "$BASE_SHA" "${{ github.sha }}" 2>/dev/null || echo "")
-          echo "psdocs=$(echo "$CHANGED" | grep -qE '^(packages/psdocs/|build/)' && echo true || echo false)" >> $GITHUB_OUTPUT
-          echo "psdocs-azure=$(echo "$CHANGED" | grep -qE '^(packages/psdocs-azure/|packages/psdocs/|build/)' && echo true || echo false)" >> $GITHUB_OUTPUT
-          echo "vscode=$(echo "$CHANGED" | grep -qE '^packages/vscode-extension/' && echo true || echo false)" >> $GITHUB_OUTPUT
+          echo "psdocs=$(echo "$CHANGED" | grep -qE '^(packages/psdocs/|build/|scripts/|build\.ps1)' && echo true || echo false)" >> $GITHUB_OUTPUT
+          echo "psdocs-azure=$(echo "$CHANGED" | grep -qE '^(packages/psdocs-azure/|packages/psdocs/|build/|scripts/|build\.ps1)' && echo true || echo false)" >> $GITHUB_OUTPUT
+          echo "vscode=$(echo "$CHANGED" | grep -qE '^(packages/vscode-extension/|\.github/workflows/vscode-ci\.yml)' && echo true || echo false)" >> $GITHUB_OUTPUT
 
   build-psdocs:
     needs: changes
@@ -51,11 +51,15 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4.3.1
         with:
-          dotnet-version: ${{ env.DOTNET_VERSION }}
+          dotnet-version: |
+            7.0.x
+            ${{ env.DOTNET_VERSION }}
       
       - name: Setup PowerShell
         shell: pwsh
         run: |
+          Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
+          Install-Module -Name InvokeBuild -MinimumVersion 5.4.0 -Scope CurrentUser -Force
           if (Test-Path packages/psdocs/pipeline.build.ps1) {
             Set-Location packages/psdocs
             Invoke-Build Build -File ./pipeline.build.ps1
@@ -72,7 +76,7 @@ jobs:
           }
       
       - name: Upload PSDocs Module
-        if: success() && hashFiles('packages/psdocs/out/modules/PSDocs/') != ''
+        if: success() && hashFiles('packages/psdocs/out/modules/PSDocs/**') != ''
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: psdocs-module
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -32,7 +32,7 @@ jobs:
           git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
 
       - name: Generate docs
-        uses: microsoft/ps-docs@main
+        uses: microsoft/ps-docs@333fc57dfef2479e0c6457600bb4c7a1316783ba # main
         with:
           modules: PSDocs,PSDocs.Azure
           inputPath: packages/psdocs-azure/templates
diff --git a/.github/workflows/release-psdocs-azure.yml b/.github/workflows/release-psdocs-azure.yml
@@ -39,7 +39,7 @@ jobs:
         shell: pwsh
         working-directory: packages/psdocs-azure
         run: |
-          Invoke-Build Build -File ./pipeline.build.ps1
+          Invoke-Build Build -File ./pipeline.build.ps1 -Build '${{ steps.version.outputs.version }}'
       
       - name: Publish to PSGallery
         shell: pwsh
@@ -54,5 +54,4 @@ jobs:
         run: |
           gh release create "${{ github.ref_name }}" \
             --title "PSDocs.Azure v${{ steps.version.outputs.version }}" \
-            --notes-file packages/psdocs-azure/CHANGELOG.md \
-            --generate-notes
+            --notes-file CHANGELOG.md
diff --git a/.github/workflows/release-psdocs.yml b/.github/workflows/release-psdocs.yml
@@ -39,7 +39,7 @@ jobs:
         shell: pwsh
         working-directory: packages/psdocs
         run: |
-          Invoke-Build Build -File ./pipeline.build.ps1
+          Invoke-Build Build -File ./pipeline.build.ps1 -Build '${{ steps.version.outputs.version }}'
       
       - name: Publish to PSGallery
         shell: pwsh
@@ -54,5 +54,4 @@ jobs:
         run: |
           gh release create "${{ github.ref_name }}" \
             --title "PSDocs v${{ steps.version.outputs.version }}" \
-            --notes-file packages/psdocs/CHANGELOG.md \
-            --generate-notes
+            --notes-file packages/psdocs/CHANGELOG.md
diff --git a/.github/workflows/release-vscode.yml b/.github/workflows/release-vscode.yml
@@ -78,5 +78,4 @@ jobs:
           gh release create "${{ github.ref_name }}" \
             --title "VS Code Extension v${{ steps.version.outputs.version }}" \
             --notes-file packages/vscode-extension/CHANGELOG.md \
-            --generate-notes \
             "${{ steps.vsix.outputs.path }}"
diff --git a/.github/workflows/vscode-ci.yml b/.github/workflows/vscode-ci.yml
@@ -161,7 +161,7 @@ jobs:
           echo "Found VSIX: $VSIX_FILE"
 
       - name: Publish to VS Marketplace (Pre-release)
-        if: env.VSCE_PAT != ''
+        if: ${{ secrets.VSCE_PAT != '' }}
         working-directory: packages/vscode-extension/out/package
         env:
           VSCE_PAT: ${{ secrets.VSCE_PAT }}
diff --git a/build/common.ps1 b/build/common.ps1
@@ -77,7 +77,7 @@ function Get-LocalPSDocsModule {
     
     if (Test-Path $localModule) {
         Write-Host "Using local PSDocs module from: $localModule"
-        $env:PSModulePath = "$localModule;$env:PSModulePath"
+        $env:PSModulePath = "$localModule$([IO.Path]::PathSeparator)$env:PSModulePath"
         return $true
     }
     
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,5 +1,5 @@
 site_name: PSDocs for Azure
-site_url: https://github.com/Azure/PSDocs.Azure
+site_url: https://azure.github.io/PSDocs.Azure/
 site_description: Generate documentation from Azure infrastructure as code (IaC) artifacts.
 site_author: Microsoft
 
diff --git a/packages/psdocs-azure/examples/bicep/storage/v1/README.md b/packages/psdocs-azure/examples/bicep/storage/v1/README.md
@@ -2,8 +2,6 @@
 
 Create or update a Storage Account.
 
-![Template checks](https://img.shields.io/badge/Template-Pass-green?style=flat-square)
-
 This template deploys a Storage Account including blob containers and files shares. Encryption in transit it enabled using a minimum of TLS 1.2.
 
 ## Parameters
diff --git a/packages/psdocs-azure/templates/acr/v1/README.md b/packages/psdocs-azure/templates/acr/v1/README.md
@@ -1,7 +1,5 @@
 # Container Registry
 
-![Template checks](https://img.shields.io/badge/Template-Pass-green?style=flat-square)
-
 Create or update a Container Registry.
 
 ## Parameters
diff --git a/packages/psdocs-azure/templates/keyvault/v1/README.md b/packages/psdocs-azure/templates/keyvault/v1/README.md
@@ -1,7 +1,5 @@
 # Key Vault
 
-![Template checks](https://img.shields.io/badge/Template-Pass-green?style=flat-square)
-
 Create or update a Key Vault.
 
 ## Parameters
diff --git a/packages/psdocs-azure/templates/storage/v1/README.md b/packages/psdocs-azure/templates/storage/v1/README.md
@@ -2,8 +2,6 @@
 
 Create or update a Storage Account.
 
-![Template checks](https://img.shields.io/badge/Template-Pass-green?style=flat-square)
-
 This template deploys a Storage Account including blob containers and files shares. Encryption in transit it enabled using a minimum of TLS 1.2.
 
 ## Parameters
diff --git a/packages/psdocs/.github/workflows/build.yaml b/packages/psdocs/.github/workflows/build.yaml
diff --git a/packages/vscode-extension/.eslintrc.json b/packages/vscode-extension/.eslintrc.json
diff --git a/packages/vscode-extension/eslint.config.mjs b/packages/vscode-extension/eslint.config.mjs
@@ -0,0 +1,28 @@
+// @ts-check
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+    {
+        files: ["src/**/*.ts"],
+        extends: [
+            eslint.configs.recommended,
+            ...tseslint.configs.recommended,
+        ],
+        rules: {
+            "@typescript-eslint/naming-convention": "warn",
+            "curly": "warn",
+            "eqeqeq": "warn",
+            "no-throw-literal": "warn",
+            // Relax rules that the original .eslintrc.json didn't enforce
+            "@typescript-eslint/no-require-imports": "off",
+            "@typescript-eslint/no-explicit-any": "off",
+            "@typescript-eslint/no-unused-vars": "off",
+            "no-var": "off",
+            "prefer-const": "off",
+        },
+    },
+    {
+        ignores: ["out/", "dist/", "**/*.d.ts"],
+    }
+);
diff --git a/packages/vscode-extension/package-lock.json b/packages/vscode-extension/package-lock.json
diff --git a/packages/vscode-extension/package.json b/packages/vscode-extension/package.json
diff --git a/scripts/pipeline-deps.ps1 b/scripts/pipeline-deps.ps1

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ function Get-LocalPSDocsModule {`
`77`	`77`
`78`	`78`	`if (Test-Path $localModule) {`
`79`	`79`	`Write-Host "Using local PSDocs module from: $localModule"`
`80`		`- $env:PSModulePath = "$localModule;$env:PSModulePath"`
	`80`	`+ $env:PSModulePath = "$localModule$([IO.Path]::PathSeparator)$env:PSModulePath"`
`81`	`81`	`return $true`
`82`	`82`	`}`
`83`	`83`