feat: enhance action validation and output schema checks in workflows

Author: MariusStorhaug

.github/workflows/Action-Test.yml

@@ -33,11 +33,25 @@ jobs:
         with:
           SettingsPath: './tests/scenarios/valid/PSModule.yml'
 
-      - name: Validate Settings Output
+      - name: Verify Action Succeeded
         shell: pwsh
         env:
           SETTINGS_JSON: ${{ steps.get-settings.outputs.Settings }}
-        run: ./tests/Validate-Settings.ps1
+        run: |
+          if ([string]::IsNullOrEmpty($env:SETTINGS_JSON)) {
+            Write-Error 'Action failed to produce settings output'
+            exit 1
+          }
+          Write-Host '✓ Action executed successfully and produced valid output'
+
+          # Verify the output is valid JSON
+          try {
+            $settings = $env:SETTINGS_JSON | ConvertFrom-Json
+            Write-Host "✓ Settings output is valid JSON with Name: $($settings.Name)"
+          } catch {
+            Write-Error "Settings output is not valid JSON: $_"
+            exit 1
+          }
 
   ActionTestInvalidMissingTestConfig:
     name: Action-Test - [Invalid - Missing Test Config]
@@ -49,21 +63,18 @@ jobs:
         with:
           persist-credentials: false
 
-      - name: Action-Test
+      - name: Action-Test (Expect Failure)
         id: get-settings
+        continue-on-error: true
         uses: ./
         with:
           SettingsPath: './tests/scenarios/invalid-missing-test-config/PSModule.yml'
 
-      - name: Validate Settings Output (Expect Failure)
+      - name: Verify Action Failed as Expected
         shell: pwsh
-        env:
-          SETTINGS_JSON: ${{ steps.get-settings.outputs.Settings }}
         run: |
-          $ErrorActionPreference = 'Continue'
-          ./tests/Validate-Settings.ps1
-          if ($LASTEXITCODE -eq 0) {
-            Write-Error 'Expected validation to fail for invalid configuration, but it succeeded'
+          if ('${{ steps.get-settings.outcome }}' -eq 'success') {
+            Write-Error 'Expected action to fail for invalid configuration, but it succeeded'
             exit 1
           }
-          Write-Host '✓ Validation failed as expected for invalid configuration'
+          Write-Host '✓ Action failed as expected for invalid configuration'

scripts/main.ps1

@@ -58,7 +58,6 @@ if (![string]::IsNullOrEmpty($settingsPath) -and (Test-Path -Path $settingsPath)
             } catch {
                 Write-Error "Schema validation failed: $_"
                 Write-Error 'Your settings file does not match the expected schema structure.'
-                Write-Error 'Please refer to the schema documentation: https://github.com/PSModule/Get-PSModuleSettings#schema'
                 throw
             }
         } else {
@@ -412,6 +411,32 @@ LogGroup 'Final settings' {
             Write-Host ($settings | ConvertTo-Json -Depth 5 | Out-String)
         }
     }
+    Set-GitHubOutput -Name Settings -Value ($settings | ConvertTo-Json -Depth 10)
 }
 
-Set-GitHubOutput -Name Settings -Value ($settings | ConvertTo-Json -Depth 10)
+LogGroup 'Validate output settings against schema' {
+    $schemaPath = Join-Path $PSScriptRoot 'Settings.schema.json'
+    if (Test-Path -Path $schemaPath) {
+        Write-Host 'Validating output settings against schema...'
+        $schema = Get-Content $schemaPath -Raw
+
+        # Convert output settings to JSON for validation
+        $outputJson = $settings | ConvertTo-Json -Depth 10
+
+        try {
+            $isValid = Test-Json -Json $outputJson -Schema $schema -ErrorAction Stop
+            if ($isValid) {
+                Write-Host '✓ Output settings conform to schema'
+            } else {
+                throw 'Output settings do not conform to the schema'
+            }
+        } catch {
+            Write-Error "Output schema validation failed: $_"
+            Write-Error 'The generated settings object does not match the expected schema structure.'
+            Write-Error 'This indicates a bug in the action. Please report this issue.'
+            throw
+        }
+    } else {
+        Write-Warning "Schema file not found at [$schemaPath]. Skipping output validation."
+    }
+}