🚀[Feature]: Linting and Documentation Improvements with Conditional Summary Option

.github/copilot-instructions.md

@@ -1,3 +1,5 @@
+# GitHub Copilot Instructions for Process-PSModule
+
 ## Terminal Commands
 
 When executing terminal commands (using `run_in_terminal` or similar tools):

.github/prompts/pr.prompt.md

@@ -24,7 +24,8 @@ $ARGUMENTS
 
 ## Execution Steps
 
-0. Change directory to the repository root if not already there.
+0. If a folder is **explicitly attached to this chat** (“references”), you **must** change directory to the root of the git folder it is in. If there are no git folders you can change to the provided folder.
+
 1. **Detect repository mode**:
    - Run `git remote -v` to check configured remotes.
    - **If `upstream` remote exists**: Fork mode
@@ -133,9 +134,9 @@ $ARGUMENTS
    - Set PR to target the default branch (main/master) of the target repository
    - Open as a **draft PR** (or keep as draft if updating)
    - **Use GitHub MCP tools** to perform these operations in the **target repository**:
-     - Create PR (if not exists) - owner/repo should be target repository, use `mcp_github_github_create_pull_request`
-     - Update PR (if exists) - owner/repo should be target repository, use `mcp_github_github_update_pull_request`
-     - Add labels to PR - owner/repo should be target repository, use `mcp_github_github_add_labels_to_issue` (PRs are issues in GitHub API)
+     - Create PR (if not exists) - owner/repo should be target repository, use `create_pull_request`
+     - Update PR (if exists) - owner/repo should be target repository, use `update_pull_request`
+     - Add labels to PR - owner/repo should be target repository, use `update_issue` (PRs are issues in GitHub API)
 
 8. **Apply labels to the PR**:
    - Add the **change type label** based on the type specified (Major, Minor, Patch, Fix, or Docs)

.github/workflows/Build-Docs.yml

@@ -32,6 +32,11 @@ on:
         description: The working directory where the script will run from.
         required: false
         default: '.'
+      ShowSummaryOnSuccess:
+        type: boolean
+        description: Whether to show the super-linter summary on success.
+        required: false
+        default: false
 
 permissions:
   contents: read # to checkout the repo
@@ -96,14 +101,15 @@ jobs:
             }
 
       - name: Lint documentation
+        id: super-linter
         uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0
         env:
-          FILTER_REGEX_INCLUDE: outputs/docs
+          RUN_LOCAL: true
           DEFAULT_BRANCH: main
           DEFAULT_WORKSPACE: ${{ inputs.WorkingDirectory }}
+          FILTER_REGEX_INCLUDE: ${{ inputs.WorkingDirectory }}/outputs/docs
           ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true
           GITHUB_TOKEN: ${{ github.token }}
-          RUN_LOCAL: true
           VALIDATE_ALL_CODEBASE: true
           VALIDATE_BIOME_FORMAT: false
           VALIDATE_BIOME_LINT: false
@@ -113,3 +119,18 @@ jobs:
           VALIDATE_JSON_PRETTIER: false
           VALIDATE_MARKDOWN_PRETTIER: false
           VALIDATE_YAML_PRETTIER: false
+          ENABLE_GITHUB_ACTIONS_STEP_SUMMARY: false
+          SAVE_SUPER_LINTER_SUMMARY: true
+
+      - name: Post super-linter summary
+        if: failure() || inputs.ShowSummaryOnSuccess == true
+        shell: pwsh
+        run: |
+          $summaryPath = Join-Path $env:GITHUB_WORKSPACE 'super-linter-output' 'super-linter-summary.md'
+          Get-Content $summaryPath | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Encoding utf8
+
+          $failed = '${{ steps.super-linter.outcome }}' -eq 'failure'
+          if ($failed) {
+              Write-Host "::error::Super-linter found issues. Please review the summary above."
+              exit 1
+          }

.github/workflows/Get-Settings.yml

@@ -209,7 +209,8 @@ jobs:
                         Skip = $settings.Build.Module.Skip ?? $false
                     }
                     Docs   = [pscustomobject]@{
-                        Skip = $settings.Build.Docs.Skip ?? $false
+                        Skip                 = $settings.Build.Docs.Skip ?? $false
+                        ShowSummaryOnSuccess = $settings.Build.Docs.ShowSummaryOnSuccess ?? $false
                     }
                     Site = [pscustomobject]@{
                         Skip = $settings.Build.Site.Skip ?? $false
@@ -231,8 +232,9 @@ jobs:
 
                 }
                 Linter  = [pscustomobject]@{
-                    Skip = $settings.Linter.Skip ?? $false
-                    env  = $settings.Linter.env ?? @{}
+                    Skip                 = $settings.Linter.Skip ?? $false
+                    ShowSummaryOnSuccess = $settings.Linter.ShowSummaryOnSuccess ?? $false
+                    env                  = $settings.Linter.env ?? @{}
                 }
             }
             LogGroup "Final settings" {

.github/workflows/workflow.yml

@@ -132,9 +132,27 @@ jobs:
           }
 
       - name: Lint code base
+        id: super-linter
         uses: super-linter/super-linter@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0
         env:
           GITHUB_TOKEN: ${{ github.token }}
+          DEFAULT_WORKSPACE: ${{ inputs.WorkingDirectory }}
+          FILTER_REGEX_INCLUDE: ${{ inputs.WorkingDirectory }}
+          ENABLE_GITHUB_ACTIONS_STEP_SUMMARY: false
+          SAVE_SUPER_LINTER_SUMMARY: true
+
+      - name: Post super-linter summary
+        if: failure() || fromJson(needs.Get-Settings.outputs.Settings).Linter.ShowSummaryOnSuccess == true
+        shell: pwsh
+        run: |
+          $summaryPath = Join-Path $env:GITHUB_WORKSPACE 'super-linter-output' 'super-linter-summary.md'
+          Get-Content $summaryPath | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Encoding utf8
+
+          $failed = '${{ steps.super-linter.outcome }}' -eq 'failure'
+          if ($failed) {
+              Write-Host "::error::Super-linter found issues. Please review the summary above."
+              exit 1
+          }
 
   # Runs on:
   # - ✅ Open/Updated PR - Builds module for testing
@@ -168,6 +186,7 @@ jobs:
       Verbose: ${{ inputs.Verbose }}
       Version: ${{ inputs.Version }}
       WorkingDirectory: ${{ inputs.WorkingDirectory }}
+      ShowSummaryOnSuccess: ${{ fromJson(needs.Get-Settings.outputs.Settings).Build.Docs.ShowSummaryOnSuccess }}
 
   # Runs on:
   # - ✅ Open/Updated PR - Builds site for preview

README.md

@@ -249,6 +249,7 @@ The following settings are available in the settings file:
 | `Build.Skip`                           | `Boolean` | Skip all build tasks                                                                                     | `false`             |
 | `Build.Module.Skip`                    | `Boolean` | Skip module build                                                                                        | `false`             |
 | `Build.Docs.Skip`                      | `Boolean` | Skip documentation build                                                                                 | `false`             |
+| `Build.Docs.ShowSummaryOnSuccess`      | `Boolean` | Show super-linter summary on success for documentation linting                                           | `false`             |
 | `Build.Site.Skip`                      | `Boolean` | Skip site build                                                                                          | `false`             |
 | `Publish.Module.Skip`                  | `Boolean` | Skip module publishing                                                                                   | `false`             |
 | `Publish.Module.AutoCleanup`           | `Boolean` | Automatically cleanup old prerelease module versions                                                     | `true`              |
@@ -261,6 +262,7 @@ The following settings are available in the settings file:
 | `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.ShowSummaryOnSuccess`          | `Boolean` | Show super-linter summary on success for repository linting                                              | `false`             |
 | `Linter.env`                           | `Object`  | Environment variables for super-linter configuration                                                     | `{}`                |
 
 <details>
@@ -275,6 +277,7 @@ Build:
     Skip: false
   Docs:
     Skip: false
+    ShowSummaryOnSuccess: false
   Site:
     Skip: false
 
@@ -332,6 +335,7 @@ Publish:
 
 Linter:
   Skip: false
+  ShowSummaryOnSuccess: false
   env: {}
 
 ```
@@ -419,6 +423,17 @@ Linter:
     VALIDATE_ALL_CODEBASE: false
 ```
 
+#### Showing Linter Summary on Success
+
+By default, the linter only shows a summary when it finds issues. You can enable summary display on successful runs:
+
+```yaml
+Linter:
+  ShowSummaryOnSuccess: true
+```
+
+This is useful for reviewing what was checked even when no issues are found.
+
 **Note:** The `GITHUB_TOKEN` is automatically provided by the workflow to enable status updates in pull requests.
 
 For a complete list of available environment variables and configuration options, see the

tests/srcTestRepo/tests/AfterAll.ps1

@@ -1,5 +1,5 @@
-Write-Host "=== AFTERALL TEARDOWN SCRIPT EXECUTING ==="
-Write-Host "Tearing down test environment..."
+Write-Warning "=== AFTERALL TEARDOWN SCRIPT EXECUTING ==="
+Write-Warning "Tearing down test environment..."
 
 # Example teardown tasks:
 # - Clean up test infrastructure
@@ -8,5 +8,5 @@ Write-Host "Tearing down test environment..."
 # - Drop test databases
 # - Stop test services
 
-Write-Host "Test environment teardown completed successfully!"
-Write-Host "=== AFTERALL TEARDOWN SCRIPT COMPLETED ==="
+Write-Warning "Test environment teardown completed successfully!"
+Write-Warning "=== AFTERALL TEARDOWN SCRIPT COMPLETED ==="

tests/srcTestRepo/tests/BeforeAll.ps1

@@ -1,5 +1,5 @@
-Write-Host "=== BEFOREALL SETUP SCRIPT EXECUTING ==="
-Write-Host "Setting up test environment..."
+Write-Warning "=== BEFOREALL SETUP SCRIPT EXECUTING ==="
+Write-Warning "Setting up test environment..."
 
 # Example setup tasks:
 # - Deploy test infrastructure
@@ -8,5 +8,5 @@ Write-Host "Setting up test environment..."
 # - Set up test databases
 # - Configure test services
 
-Write-Host "Test environment setup completed successfully!"
-Write-Host "=== BEFOREALL SETUP SCRIPT COMPLETED ==="
+Write-Warning "Test environment setup completed successfully!"
+Write-Warning "=== BEFOREALL SETUP SCRIPT COMPLETED ==="

tests/srcWithManifestTestRepo/tests/AfterAll.ps1

@@ -1,8 +1,8 @@
-Write-Host "=== AFTERALL TEARDOWN SCRIPT (Environments) EXECUTING ==="
-Write-Host "Tearing down test environment for Environments..."
+Write-Warning "=== AFTERALL TEARDOWN SCRIPT (Environments) EXECUTING ==="
+Write-Warning "Tearing down test environment for Environments..."
 
 # Example teardown tasks for Environments directory:
-Write-Host "Cleaning up Environments test environment..."
+Write-Warning "Cleaning up Environments test environment..."
 
-Write-Host "Environments environment teardown completed successfully!"
-Write-Host "=== AFTERALL TEARDOWN SCRIPT (Environments) COMPLETED ==="
+Write-Warning "Environments environment teardown completed successfully!"
+Write-Warning "=== AFTERALL TEARDOWN SCRIPT (Environments) COMPLETED ==="

tests/srcWithManifestTestRepo/tests/BeforeAll.ps1

@@ -1,8 +1,8 @@
-Write-Host "=== BEFOREALL SETUP SCRIPT EXECUTING ==="
-Write-Host "Setting up test environment..."
+Write-Warning "=== BEFOREALL SETUP SCRIPT EXECUTING ==="
+Write-Warning "Setting up test environment..."
 
 # Example setup tasks for test environment:
-Write-Host "Initializing test environment..."
+Write-Warning "Initializing test environment..."
 
-Write-Host "Test environment setup completed successfully!"
-Write-Host "=== BEFOREALL SETUP SCRIPT COMPLETED ==="
+Write-Warning "Test environment setup completed successfully!"
+Write-Warning "=== BEFOREALL SETUP SCRIPT COMPLETED ==="