feat: add JSON schema validation for settings and update README with action description

Author: MariusStorhaug

README.md

@@ -1,17 +1,3 @@
-# Template-Action
+# Get-PSModuleSettings
 
-A template repository for GitHub Actions
-
-## Usage
-
-### Inputs
-
-### Secrets
-
-### Outputs
-
-### Example
-
-```yaml
-Example here
-```
+This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule).

tests/Settings.schema.json scripts/Settings.schema.jsontests/Settings.schema.json renamed to scripts/Settings.schema.json

@@ -38,6 +38,33 @@ if (![string]::IsNullOrEmpty($settingsPath) -and (Test-Path -Path $settingsPath)
             }
         }
     }
+
+    LogGroup 'Validate settings against schema' {
+        $schemaPath = Join-Path $PSScriptRoot 'Settings.schema.json'
+        if (Test-Path -Path $schemaPath) {
+            Write-Host 'Validating settings against schema...'
+            $schema = Get-Content $schemaPath -Raw
+
+            # Convert settings to JSON for validation
+            $settingsJson = $settings | ConvertTo-Json -Depth 10
+
+            try {
+                $isValid = Test-Json -Json $settingsJson -Schema $schema -ErrorAction Stop
+                if ($isValid) {
+                    Write-Host '✓ Settings conform to schema'
+                } else {
+                    throw 'Settings do not conform to the schema'
+                }
+            } 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 {
+            Write-Warning "Schema file not found at [$schemaPath]. Skipping validation."
+        }
+    }
 } else {
     Write-Host 'No settings file present.'
     $settings = @{}
@@ -134,15 +161,14 @@ $settings = [pscustomobject]@{
             Skip                  = $settings.Publish.Module.Skip ?? $false
             AutoCleanup           = $settings.Publish.Module.AutoCleanup ?? $true
             AutoPatching          = $settings.Publish.Module.AutoPatching ?? $true
-            IncrementalPrerelease = $settings.Publish.Module.IncrementalPrerelease ?? $true
+            IncrementalPrerelease = $settings.Publish.Module.IncrementalPrerelease ?? $trueø
             DatePrereleaseFormat  = $settings.Publish.Module.DatePrereleaseFormat ?? ''
             VersionPrefix         = $settings.Publish.Module.VersionPrefix ?? 'v'
             MajorLabels           = $settings.Publish.Module.MajorLabels ?? 'major, breaking'
             MinorLabels           = $settings.Publish.Module.MinorLabels ?? 'minor, feature'
             PatchLabels           = $settings.Publish.Module.PatchLabels ?? 'patch, fix'
             IgnoreLabels          = $settings.Publish.Module.IgnoreLabels ?? 'NoRelease'
         }
-
     }
     Linter  = [pscustomobject]@{
         Skip                 = $settings.Linter.Skip ?? $false

scripts/main.ps1

@@ -36,7 +36,7 @@ Write-Host '=============================================='
 
 # Validate against JSON schema
 Write-Host "`nValidating settings against JSON schema..."
-$schemaPath = Join-Path $PSScriptRoot 'Settings.schema.json'
+$schemaPath = Join-Path $PSScriptRoot '..' 'scripts' 'Settings.schema.json'
 $schema = Get-Content $schemaPath -Raw
 $isValid = Test-Json -Json $SettingsJson -Schema $schema