📝[Enhancement]: Add Linter configuration options to skip linting and set environment variables; update documentation accordingly.

Author: MariusStorhaug

.github/workflows/Get-Settings.yml

@@ -230,6 +230,10 @@ jobs:
                     }
 
                 }
+                Linter  = [pscustomobject]@{
+                    Skip = $settings.Linter.Skip ?? $false
+                    env  = $settings.Linter.env ?? @{}
+                }
             }
             LogGroup "Final settings" {
                 switch -Regex ($settingsFile.Extension) {

.github/workflows/workflow.yml

@@ -99,7 +99,7 @@ jobs:
   Lint-Repository:
     name: Lint code base
     runs-on: ubuntu-latest
-    if: github.event_name == 'pull_request' && github.event.pull_request.merged != true && github.event.action != 'closed'
+    if: github.event_name == 'pull_request' && github.event.pull_request.merged != true && github.event.action != 'closed' && fromJson(needs.Get-Settings.outputs.Settings).Linter.Skip != true
     needs:
       - Get-Settings
     steps:

README.md

@@ -260,6 +260,8 @@ The following settings are available in the settings file:
 | `Publish.Module.MinorLabels`           | `String`  | Labels indicating a minor version bump                                                                   | `'minor, feature'`  |
 | `Publish.Module.PatchLabels`           | `String`  | Labels indicating a patch version bump                                                                   | `'patch, fix'`      |
 | `Publish.Module.IgnoreLabels`          | `String`  | Labels indicating no release                                                                             | `'NoRelease'`       |
+| `Linter.Skip`                          | `Boolean` | Skip repository linting                                                                                  | `false`             |
+| `Linter.env`                           | `Object`  | Environment variables for super-linter configuration                                                     | `{}`                |
 
 <details>
 <summary>`PSModule.yml` with all defaults</summary>
@@ -328,6 +330,10 @@ Publish:
     PatchLabels: 'patch, fix'
     IgnoreLabels: 'NoRelease'
 
+Linter:
+  Skip: false
+  env: {}
+
 ```
 </details>
 
@@ -365,6 +371,31 @@ Build:
     Skip: true
 ```
 
+### Example 3 - Configuring the Repository Linter
+
+This example shows how to configure the repository linter to skip certain validations or disable the linter entirely.
+
+```yaml
+# Skip the linter entirely
+Linter:
+  Skip: true
+```
+
+```yaml
+# Disable specific linter validations
+Linter:
+  env:
+    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
+```
+
+For a complete list of available linter environment variables, see the [super-linter documentation](https://github.com/super-linter/super-linter#environment-variables).
+
 ## Specifications and practices
 
 The process is compatible with:

tests/srcWithManifestTestRepo/.github/PSModule.yml

@@ -12,6 +12,7 @@ Test:
 Publish:
   AutoCleanup: false
 Linter:
+  Skip: true
   env:
     VALIDATE_BIOME_FORMAT: false
     VALIDATE_BIOME_LINT: false