Add configurable ImportantFilePatterns setting

Author: MariusStorhaug

README.md

@@ -1,3 +1,42 @@
 # Get-PSModuleSettings
 
 This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule).
+
+## Inputs
+
+| Input | Description | Required | Default |
+| :---- | :---------- | :------: | :------ |
+| `Name` | Name of the module. | No | Repository name |
+| `SettingsPath` | Path to the settings file (json, yaml/yml, or psd1). | No | |
+| `ImportantFilePatterns` | Newline-separated list of regex patterns that identify important files. Changes matching these patterns trigger build, test, and publish stages. | No | `^src/` and `^README\.md$` |
+| `Debug` | Enable debug output. | No | `false` |
+| `Verbose` | Enable verbose output. | No | `false` |
+| `Version` | Specifies the version of the GitHub module to be installed. | No | |
+| `Prerelease` | Allow prerelease versions if available. | No | `false` |
+| `WorkingDirectory` | The working directory where the script will run from. | No | `${{ github.workspace }}` |
+
+## Settings file
+
+The action reads settings from a file (default: `.github/PSModule.yml`). Settings in the file take precedence over action inputs.
+
+### ImportantFilePatterns
+
+Controls which file changes trigger build, test, and publish stages. When a PR only changes files that don't match any
+of these patterns, those stages are skipped.
+
+Default patterns (used when not configured):
+
+- `^src/` — Module source code
+- `^README\.md$` — Root documentation
+
+To override, add `ImportantFilePatterns` to your settings file:
+
+```yaml
+ImportantFilePatterns:
+  - '^src/'
+  - '^README\.md$'
+  - '^examples/'
+```
+
+When configured, the provided list fully replaces the defaults. Include the default patterns in your list if you still
+want them to trigger releases.

action.yml

@@ -31,6 +31,15 @@ inputs:
     description: The working directory where the script will run from.
     required: false
     default: ${{ github.workspace }}
+  ImportantFilePatterns:
+    description: |
+      Newline-separated list of regex patterns that identify important files.
+      Changes matching these patterns trigger build, test, and publish stages.
+      When set, fully replaces the defaults.
+    required: false
+    default: |
+      ^src/
+      ^README\.md$
 
 outputs:
   Settings:
@@ -51,6 +60,7 @@ runs:
         PSMODULE_GET_SETTINGS_INPUT_Version: ${{ inputs.Version }}
         PSMODULE_GET_SETTINGS_INPUT_Prerelease: ${{ inputs.Prerelease }}
         PSMODULE_GET_SETTINGS_INPUT_WorkingDirectory: ${{ inputs.WorkingDirectory }}
+        PSMODULE_GET_SETTINGS_INPUT_ImportantFilePatterns: ${{ inputs.ImportantFilePatterns }}
       with:
         Name: Get-PSModuleSettings
         ShowInfo: false

src/Settings.schema.json

@@ -9,6 +9,13 @@
       "type": "string",
       "description": "The name of the module"
     },
+    "ImportantFilePatterns": {
+      "type": "array",
+      "description": "Regex patterns that identify important files. Changes matching these patterns trigger build, test, and publish stages. Defaults to ['^src/', '^README\\.md$'] when not configured.",
+      "items": {
+        "type": "string"
+      }
+    },
     "Test": {
       "type": "object",
       "description": "Test configuration settings",

src/main.ps1

@@ -7,6 +7,7 @@ $verbose = $env:PSMODULE_GET_SETTINGS_INPUT_Verbose
 $version = $env:PSMODULE_GET_SETTINGS_INPUT_Version
 $prerelease = $env:PSMODULE_GET_SETTINGS_INPUT_Prerelease
 $workingDirectory = $env:PSMODULE_GET_SETTINGS_INPUT_WorkingDirectory
+$importantFilePatternsInput = $env:PSMODULE_GET_SETTINGS_INPUT_ImportantFilePatterns
 
 LogGroup 'Inputs' {
     [pscustomobject]@{
@@ -89,8 +90,23 @@ LogGroup 'Name' {
     }
 }
 
+LogGroup 'ImportantFilePatterns' {
+    $defaultImportantFilePatterns = @('^src/', '^README\.md$')
+    if ($settings.ImportantFilePatterns -and $settings.ImportantFilePatterns.Count -gt 0) {
+        $importantFilePatterns = @($settings.ImportantFilePatterns)
+        Write-Host "Using ImportantFilePatterns from settings file: [$($importantFilePatterns -join ', ')]"
+    } elseif (-not [string]::IsNullOrWhiteSpace($importantFilePatternsInput)) {
+        $importantFilePatterns = @($importantFilePatternsInput -split "`n" | ForEach-Object { $_.Trim() } | Where-Object { $_ })
+        Write-Host "Using ImportantFilePatterns from action input: [$($importantFilePatterns -join ', ')]"
+    } else {
+        $importantFilePatterns = $defaultImportantFilePatterns
+        Write-Host "Using default ImportantFilePatterns: [$($importantFilePatterns -join ', ')]"
+    }
+}
+
 $settings = [pscustomobject]@{
-    Name    = $name
+    Name                  = $name
+    ImportantFilePatterns = $importantFilePatterns
     Test    = [pscustomobject]@{
         Skip         = $settings.Test.Skip ?? $false
         Linux        = [pscustomobject]@{
@@ -251,11 +267,8 @@ LogGroup 'Calculate Job Run Conditions:' {
             Write-Host "Changed files ($($changedFiles.Count)):"
             $changedFiles | ForEach-Object { Write-Host "  - $_" }
 
-            # Define important file patterns
-            $importantPatterns = @(
-                '^src/'
-                '^README\.md$'
-            )
+            # Use configured important file patterns
+            $importantPatterns = $settings.ImportantFilePatterns
 
             # Check if any changed file matches an important pattern
             foreach ($file in $changedFiles) {
@@ -276,15 +289,17 @@ LogGroup 'Calculate Job Run Conditions:' {
 
                 # Add a comment to open PRs explaining why build/test is skipped (best-effort, may fail if permissions not granted)
                 if ($isOpenOrUpdatedPR) {
+                    $patternRows = ($importantPatterns | ForEach-Object {
+                        "| ``$_`` | Matches files where path matches this pattern |"
+                    }) -join "`n"
                     $commentBody = @"
 ### No Significant Changes Detected
 
 This PR does not contain changes to files that would trigger a new release:
 
-| Path | Description |
+| Pattern | Description |
 | :--- | :---------- |
-| ``src/**`` | Module source code |
-| ``README.md`` | Documentation |
+$patternRows
 
 **Build, test, and publish stages will be skipped** for this PR.