🌟[Major] Introducing Get-PSModuleSettings GitHub Action (#1)

This release introduces a new GitHub Action, `Get-PSModuleSettings`,
which replaces the previous template action in
[PSModule/Process-PSModule](https://github.com/PSModule/Process-PSModule).
The action is designed to load and process PowerShell module workflow
settings from configuration files, compute job run conditions, and
output structured settings and test suite information for use in CI
pipelines.

## How It Works

The `Get-PSModuleSettings` action:

1. **Loads settings** from a specified configuration file (supporting
JSON, YAML, or PSD1 formats)
2. **Validates settings** against a comprehensive JSON schema to ensure
correctness
3. **Applies defaults** for any missing configuration values
4. **Generates test suite matrices** for multiple operating systems
(Linux, macOS, Windows) based on test discovery
5. **Computes job run conditions** based on PR state (open, updated,
merged, abandoned)
6. **Outputs structured JSON** containing all settings, test suites, and
run conditions for downstream workflow steps

### Configuration Format Support

The action supports three configuration formats:
- **JSON** - Standard JSON configuration files
- **YAML/YML** - Human-readable YAML format
- **PSD1** - PowerShell Data File format (native PowerShell hashtables)

### Test Suite Generation

The action automatically discovers and categorizes tests into three
types:
- **SourceCode tests** - Static analysis and linting of source code
- **PSModule tests** - Tests for the built PowerShell module
- **Module tests** - Integration and functional tests with test matrices
for each OS

Test discovery supports:
- `*.Configuration.ps1` - Test configuration files
- `*.Container.ps1` - Test container files
- `*.Tests.ps1` - Standard Pester test files

### Job Run Conditions

The action calculates intelligent run conditions for each workflow job
based on:
- Pull request state (open, updated, merged, abandoned)
- Configuration skip flags
- Test suite availability
- Ensures abandoned PRs don't waste CI resources

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: MariusStorhaug

.github/linters/.powershell-psscriptanalyzer.psd1

@@ -50,6 +50,7 @@
         }
     }
     ExcludeRules = @(
+        'PSAvoidUsingWriteHost',        # Write-Host is acceptable in GitHub Actions runners
         'PSMissingModuleManifestField', # This rule is not applicable until the module is built.
         'PSUseToExportFieldsInManifest'
     )

.github/workflows/Action-Test.yml

@@ -17,8 +17,8 @@ permissions:
   pull-requests: read
 
 jobs:
-  ActionTestBasic:
-    name: Action-Test - [Basic]
+  ActionTestValid:
+    name: Action-Test - [Valid Configuration]
     runs-on: ubuntu-latest
     steps:
       # Need to check out as part of the test, as its a local action
@@ -28,6 +28,33 @@ jobs:
           persist-credentials: false
 
       - name: Action-Test
+        id: get-settings
         uses: ./
         with:
-          Subject: PSModule
+          SettingsPath: './tests/scenarios/valid/PSModule.yml'
+
+  ActionTestInvalidMissingTestConfig:
+    name: Action-Test - [Invalid - Missing Test Config]
+    runs-on: ubuntu-latest
+    steps:
+      # Need to check out as part of the test, as its a local action
+      - name: Checkout repo
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        with:
+          persist-credentials: false
+
+      - name: Action-Test (Expect Failure)
+        id: get-settings
+        continue-on-error: true
+        uses: ./
+        with:
+          SettingsPath: './tests/scenarios/invalid-percent-target/PSModule.yml'
+
+      - name: Verify Action Failed as Expected
+        shell: pwsh
+        run: |
+          if ('${{ steps.get-settings.outcome }}' -eq 'success') {
+            Write-Error 'Expected action to fail for invalid configuration, but it succeeded'
+            exit 1
+          }
+          Write-Host '✓ Action failed as expected for invalid configuration'

.github/workflows/Linter.yml

@@ -28,6 +28,10 @@ jobs:
         uses: super-linter/super-linter@d5b0a2ab116623730dd094f15ddc1b6b25bf7b99 # v8.3.2
         env:
           GITHUB_TOKEN: ${{ github.token }}
+          VALIDATE_BIOME_FORMAT: false
+          VALIDATE_BIOME_LINT: false
+          VALIDATE_GITHUB_ACTIONS_ZIZMOR: false
+          VALIDATE_JSCPD: false
           VALIDATE_JSON_PRETTIER: false
           VALIDATE_MARKDOWN_PRETTIER: false
           VALIDATE_YAML_PRETTIER: false

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 PSModule
+Copyright (c) 2026 PSModule
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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).

action.yml

@@ -1,15 +1,17 @@
-name: Template-Action
-description: A template action for GitHub Actions using PowerShell
+name: Get-PSModuleSettings
+description: Get settings for a PowerShell module workflow
 author: PSModule
 branding:
-  icon: upload-cloud
-  color: white
+  icon: settings
+  color: blue
 
 inputs:
-  Subject:
-    description: The subject to greet
+  Name:
+    description: Name of the module.
+    required: false
+  SettingsPath:
+    description: Path to the settings file (json, yaml/yml, or psd1)
     required: false
-    default: World
   Debug:
     description: Enable debug output.
     required: false
@@ -30,15 +32,29 @@ inputs:
     required: false
     default: ${{ github.workspace }}
 
+outputs:
+  Settings:
+    description: The complete settings object as JSON, including test suites
+    value: ${{ fromJson(steps.Get-PSModuleSettings.outputs.result).Settings }}
+
 runs:
   using: composite
   steps:
-    - name: Template-Action
+    - name: Get-PSModuleSettings
       uses: PSModule/GitHub-Script@8b9d2739d6896975c0e5448d2021ae2b94b6766a # v1.7.6
+      id: Get-PSModuleSettings
       env:
-        PSMOUDLE_TEMPLATE_ACTION_INPUT_Subject: ${{ inputs.Subject }}
+        PSMODULE_GET_SETTINGS_INPUT_Name: ${{ inputs.Name }}
+        PSMODULE_GET_SETTINGS_INPUT_SettingsPath: ${{ inputs.SettingsPath }}
+        PSMODULE_GET_SETTINGS_INPUT_Debug: ${{ inputs.Debug }}
+        PSMODULE_GET_SETTINGS_INPUT_Verbose: ${{ inputs.Verbose }}
+        PSMODULE_GET_SETTINGS_INPUT_Version: ${{ inputs.Version }}
+        PSMODULE_GET_SETTINGS_INPUT_Prerelease: ${{ inputs.Prerelease }}
+        PSMODULE_GET_SETTINGS_INPUT_WorkingDirectory: ${{ inputs.WorkingDirectory }}
       with:
-        Name: Template-Action
+        Name: Get-PSModuleSettings
+        ShowInfo: false
+        ShowOutput: true
         Debug: ${{ inputs.Debug }}
         Prerelease: ${{ inputs.Prerelease }}
         Verbose: ${{ inputs.Verbose }}