Comparing changes

…zation (#150) The **PSModule v4 release** is a major overhaul of the PowerShell module workflow, introducing significant architectural changes to improve speed, modularity, and maintainability. This update continues on the goal to split the once-monolithic process into distinct GitHub Actions for building, testing, documenting, and publishing modules. By refactoring the workflow into isolated steps and enabling parallel execution, v4 dramatically optimizes build and test times while ensuring a more reliable and customizable process for module developers. ![image](https://github.com/user-attachments/assets/a583c4bd-e8ea-45dc-9164-a254f4764fa5) <details><summary>Diagram - Old version</summary> <p> ![image](https://github.com/user-attachments/assets/679bc459-44cd-4f50-8a98-e70bb4977068) </p> </details> ## Features ### Parallel Testing & Results Aggregation The workflow has been reworked to support flexible, parallelizable test runs. The `Test-PSModule` action will now execute tests in parallel via matrix jobs (e.g. across multiple OSes or test stages). Separate helper actions (`Get-PesterTestResults` and `Get-PesterCodeCoverage`) have been introduced to aggregate Pester test outcomes and code coverage from those parallel jobs, providing unified reporting and enforcing test success and coverage thresholds across the matrix. - Fixes #78 - Fixes #119 ### Central Configuration File A new configuration hierarchy allows customizing the process through a YAML (JSON or PSD1) settings file. Users can include a `.github/PSModule.yml` in their module repo to override defaults. This centralized config makes the pipeline more flexible and eliminates the need for hard-coded inputs in workflow files. - Fixes #144 - Fixes #81 - Fixes #159 ### Dedicated Documentation Step Documentation generation is now handled by a new `Document-PSModule` action. This step automatically builds the module's documentation (using PlatyPS) and uploads as an artifact, so that other steps can build a site and publish it to GitHub Pages. By isolating documentation in its own action, v4 ensures that doc-specific tools (e.g. PlatyPS and MkDocs) run without interference from build or test modules, and documentation is kept up-to-date with each release. - Fixes #148 - Fixes #77 - Fixes #95 ### Shared Helper Module Action A new `Install-PSModuleHelpers` action has been introduced as a foundational setup step. It installs and configures common helper functions used by the pipeline (for example, version specification conversion, module dependency resolution, and module installation utilities). This ensures all subsequent actions operate with a consistent environment and shared logic. Common functionality like resolving module dependencies (`Resolve-PSModuleDependency`) and version parsing has been consolidated here, reducing duplication across the build/test/publish steps. ### Enhanced Platform and Compatibility Support The v4 workflow expands support and testing across platforms and PowerShell versions. The Test-PSModule action runs on Windows, Linux, and macOS with PowerShell Core (and includes light support for Windows PowerShell 5.1 for basic compatibility). - Fixes #146 ### New test actions Static analysis is performed via a dedicated `Invoke-ScriptAnalyzer` GitHub action, and Pester tests are executed in an isolated context via the `Invoke-Pester` GitHub action, ensuring consistent behavior across different environments and increases the reusability of the automation we built around Pester. The new design also honors repository-specific analyzer settings (automatically picking up settings from `.github/linters/.powershell-psscriptanalyzer.psd1` in the repo for static code analysis), allowing module developers to customize linting rules. - Fixes #108 - Fixes #130 ### Modular Workflows By splitting the CI/CD process into discrete actions and enabling concurrency, the overall pipeline runtime is greatly reduced. Linting, unit tests, and integration tests can run in parallel, and the build step no longer blocks documentation or analysis. This *time-optimized process* means quicker feedback on pull requests and faster delivery of new module releases. ### Simplified Build & Publish Process The `Build-PSModule` action has been refactored into a pure module builder. New inputs like `ArtifactName` and `WorkingDirectory` give more control over build output naming and source path. The build step now produces a clean module package and uploads it as an artifact called `module`. Likewise, the **Publish-PSModule** action has been bumped to v2 with a clearer interface – it removes the old monolithic `ConfigurationFile` input in favor of explicit inputs and the new central settings file. The publish logic now uses the repository’s context (working directory defaulting to `.`) and respects the unified settings, simplifying how modules are published to the PowerShell Gallery. ### Robust Dependency Handling Module dependency resolution during builds is now more reliable and up-to-date. The pipeline switched to using **PSResourceGet** for installing required module dependencies, replacing the legacy PowerShellGet v2 approach. This change ensures compatibility with the latest PowerShell module packaging standards and improves the speed and success of acquiring dependencies. The helper scripts (`Convert-VersionSpec` and `Resolve-PSModuleDependency`) were moved into the shared helpers module, and their logic was hardened with better retry and null-check mechanisms when querying the PowerShell Gallery. - Fixes #62 ### Better Logging and Diagnostics Each action now provides more transparent logging and output for easier troubleshooting. The Publish step, for example, now logs all input parameters at the start of execution for traceability. Verbose logging in dependency resolution has been replaced with clear console output to ensure important information is always visible. The `Get-PesterTestResults` action prints a detailed summary of test suites executed, including counts of passed/failed/skipped tests, and will mark the workflow as failed if any tests did not run or failed – giving immediate feedback if something went wrong in the parallel test jobs. - Fixes #91 ### Other smaller issues - Fixes #82 ## Related actions and PRs - [Install-PSModuleHelpers](https://github.com/PSModule/Install-PSModuleHelpers) | PSModule/Install-PSModuleHelpers#2 - [Test-PSModule](https://github.com/PSModule/Test-PSModule) | PSModule/Test-PSModule#98 - [Get-PesterTestResults](https://github.com/PSModule/Get-PesterTestResults) | PSModule/Get-PesterTestResults#2 - [Get-PesterCodeCoverage](https://github.com/PSModule/Get-PesterCodeCoverage) | PSModule/Get-PesterCodeCoverage#1 - [Invoke-Pester](https://github.com/PSModule/Invoke-Pester) - [Invoke-ScriptAnalyzer](https://github.com/PSModule/Invoke-ScriptAnalyzer) - [Document-PSModule](https://github.com/PSModule/Document-PSModule) | PSModule/Document-PSModule#16 - [Build-PSModule](https://github.com/PSModule/Build-PSModule) | PSModule/Build-PSModule#108 - [Publish-PSModule](https://github.com/PSModule/Publish-PSModule) | PSModule/Publish-PSModule#49

#161) ## Description This pull request reverts changes to the `.github/workflows/Test-ModuleLocal.yml` file to restore testing capabilities and module loading performance. Details: * Restored the `GITHUB_TOKEN` environment variable mapping, allowing it to be used in tests once more. * Restored the `Prescript` step to preload the module with a specific version, optimizing module loading during Pester tests.

## Description This pull request introduces a small but important update to the GitHub Actions workflow configuration. It ensures that the latest version of the `Microsoft.PowerShell.PSResourceGet` module is installed before publishing a PowerShell module. - Fixes PSModule/NerdFonts#33 * [`.github/workflows/workflow.yml`](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R290-R294): Added a step to install the `Microsoft.PowerShell.PSResourceGet` module from the PSGallery repository using `Install-PSResource`. ## Type of change  - [ ] 📖 [Docs] - [x] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas

…#166) ## Description This pull request updates the `.github/workflows/Test-ModuleLocal.yml` file to optimize module loading during Pester tests by installing a required PowerShell resource. Workflow optimization: * [`.github/workflows/Test-ModuleLocal.yml`](diffhunk://#diff-bc9fc4fcc46bb3f5c486f48b3708cb239d73c94b983b4e72815d093825c94581R134): Added a step to install the `PSCustomObject` module from the `PSGallery` repository to streamline module loading in Pester. ## Type of change  - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas

## Description This pull request simplifies the workflow configuration by removing the `Initialize-PSModule` step from two GitHub Actions workflows. This change reduces redundancy and streamlines the build and artifact download processes. Workflow updates: * [`.github/workflows/Build-Module.yml`](diffhunk://#diff-288da0616802a69b7e5aa63f771fe1525eda2ec5b576e26423f28380b2e68833L47-L55): Removed the `Initialize-PSModule` step, which previously set up the environment for building the module. * [`.github/workflows/workflow.yml`](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1L276-L283): Removed the `Initialize-PSModule` step, which was used to prepare the environment before downloading module artifacts. ## Type of change  - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas

## Description This pull request includes updates to the workflow files to improve clarity and functionality. The changes primarily focus on refining conditional logic in PowerShell scripts and enhancing environment variable handling in GitHub Actions. ### Workflow improvements: * [`.github/workflows/Get-Settings.yml`](diffhunk://#diff-68f351d419a9b4db4797434891d5dfad44d83de65bfee7ba1c60badae369dbefL134-R140): Updated the conditional logic for determining the `$name` variable to use explicit `if-elseif-else` statements, improving readability and maintainability. ### Environment variable and input adjustments: * [`.github/workflows/workflow.yml`](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R289-L297): Added the `GH_TOKEN` environment variable to the `Publish module` step to ensure authentication is handled securely. * [`.github/workflows/workflow.yml`](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1R305): Reintroduced the `WorkingDirectory` input to the `Publish module` step for better modularity and flexibility in specifying paths. ## Type of change  - [ ] 📖 [Docs] - [x] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas

## Description This pull request updates several GitHub Actions workflows to simplify input parameters and improve artifact handling. Key changes include the removal of unused parameters (`Debug`, `Verbose`, `Version`, and `Prerelease`) and the addition of an `ArtifactName` parameter for uploading artifacts. Additionally, environment variables are introduced for authentication. ### Simplification of input parameters: * [`.github/workflows/Build-Module.yml`](diffhunk://#diff-288da0616802a69b7e5aa63f771fe1525eda2ec5b576e26423f28380b2e68833L10-R14): Removed unused parameters (`Debug`, `Verbose`, `Version`, and `Prerelease`) and added a new `ArtifactName` parameter to specify the name of the artifact to upload. [[1]](diffhunk://#diff-288da0616802a69b7e5aa63f771fe1525eda2ec5b576e26423f28380b2e68833L10-R14) [[2]](diffhunk://#diff-288da0616802a69b7e5aa63f771fe1525eda2ec5b576e26423f28380b2e68833L51-R38) ### Environment variable addition: * [`.github/workflows/Build-Module.yml`](diffhunk://#diff-288da0616802a69b7e5aa63f771fe1525eda2ec5b576e26423f28380b2e68833R28-R29): Added the `GH_TOKEN` environment variable for authentication using GitHub's token. ### Consistency across workflows: * `.github/workflows/CI.yml` and `.github/workflows/workflow.yml`: Removed references to unused parameters (`Debug`, `Verbose`, `Version`, and `Prerelease`) to align with the updated `Build-Module.yml`. [[1]](diffhunk://#diff-3ab46ee209a127470fce3c2cf106b1a1dbadbb929a4b5b13656a4bc4ce19c0b8L90-L93) [[2]](diffhunk://#diff-126bf89616b7daa3d14ebc882ad18666aaf1c3dae888c4ba306a66ec80758bc1L92-L95) ## Type of change  - [ ] 📖 [Docs] - [x] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas

Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 4 to 5. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/actions/download-artifact/releases">actions/download-artifact's releases</a>.</em></p> <blockquote> <h2>v5.0.0</h2> <h2>What's Changed</h2> <ul> <li>Update README.md by <a href="https://github.com/nebuk89"><code>@nebuk89</code></a> in <a href="https://redirect.github.com/actions/download-artifact/pull/407">actions/download-artifact#407</a></li> <li>BREAKING fix: inconsistent path behavior for single artifact downloads by ID by <a href="https://github.com/GrantBirki"><code>@GrantBirki</code></a> in <a href="https://redirect.github.com/actions/download-artifact/pull/416">actions/download-artifact#416</a></li> </ul> <h2>v5.0.0</h2> <h3>🚨 Breaking Change</h3> <p>This release fixes an inconsistency in path behavior for single artifact downloads by ID. <strong>If you're downloading single artifacts by ID, the output path may change.</strong></p> <h4>What Changed</h4> <p>Previously, <strong>single artifact downloads</strong> behaved differently depending on how you specified the artifact:</p> <ul> <li><strong>By name</strong>: <code>name: my-artifact</code> → extracted to <code>path/</code> (direct)</li> <li><strong>By ID</strong>: <code>artifact-ids: 12345</code> → extracted to <code>path/my-artifact/</code> (nested)</li> </ul> <p>Now both methods are consistent:</p> <ul> <li><strong>By name</strong>: <code>name: my-artifact</code> → extracted to <code>path/</code> (unchanged)</li> <li><strong>By ID</strong>: <code>artifact-ids: 12345</code> → extracted to <code>path/</code> (fixed - now direct)</li> </ul> <h4>Migration Guide</h4> <h5>✅ No Action Needed If:</h5> <ul> <li>You download artifacts by <strong>name</strong></li> <li>You download <strong>multiple</strong> artifacts by ID</li> <li>You already use <code>merge-multiple: true</code> as a workaround</li> </ul> <h5>⚠️ Action Required If:</h5> <p>You download <strong>single artifacts by ID</strong> and your workflows expect the nested directory structure.</p> <p><strong>Before v5 (nested structure):</strong></p> <pre lang="yaml"><code>- uses: actions/download-artifact@v4 with: artifact-ids: 12345 path: dist # Files were in: dist/my-artifact/ </code></pre> <blockquote> <p>Where <code>my-artifact</code> is the name of the artifact you previously uploaded</p> </blockquote> <p><strong>To maintain old behavior (if needed):</strong></p> <pre lang="yaml"><code></tr></table> </code></pre> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/actions/download-artifact/commit/634f93cb2916e3fdff6788551b99b062d0335ce0"><code>634f93c</code></a> Merge pull request <a href="https://redirect.github.com/actions/download-artifact/issues/416">#416</a> from actions/single-artifact-id-download-path</li> <li><a href="https://github.com/actions/download-artifact/commit/b19ff4302770b82aa4694b63703b547756dacce6"><code>b19ff43</code></a> refactor: resolve download path correctly in artifact download tests (mainly ...</li> <li><a href="https://github.com/actions/download-artifact/commit/e262cbee4ab8c473c61c59a81ad8e9dc760e90db"><code>e262cbe</code></a> bundle dist</li> <li><a href="https://github.com/actions/download-artifact/commit/bff23f9308ceb2f06d673043ea6311519be6a87b"><code>bff23f9</code></a> update docs</li> <li><a href="https://github.com/actions/download-artifact/commit/fff8c148a8fdd56aa81fcb019f0b5f6c65700c4d"><code>fff8c14</code></a> fix download path logic when downloading a single artifact by id</li> <li><a href="https://github.com/actions/download-artifact/commit/448e3f862ab3ef47aa50ff917776823c9946035b"><code>448e3f8</code></a> Merge pull request <a href="https://redirect.github.com/actions/download-artifact/issues/407">#407</a> from actions/nebuk89-patch-1</li> <li><a href="https://github.com/actions/download-artifact/commit/47225c44b359a5155efdbbbc352041b3e249fb1b"><code>47225c4</code></a> Update README.md</li> <li>See full diff in <a href="https://github.com/actions/download-artifact/compare/v4...v5">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=actions/download-artifact&package-manager=github_actions&previous-version=4&new-version=5)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact) from 3 to 4. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/actions/upload-pages-artifact/releases">actions/upload-pages-artifact's releases</a>.</em></p> <blockquote> <h2>v4.0.0</h2> <h2>What's Changed</h2> <ul> <li>Potentially breaking change: hidden files (specifically dotfiles) will not be included in the artifact by <a href="https://github.com/tsusdere"><code>@tsusdere</code></a> in <a href="https://redirect.github.com/actions/upload-pages-artifact/pull/102">actions/upload-pages-artifact#102</a> If you need to include dotfiles in your artifact: instead of using this action, create your own artifact according to these requirements <a href="https://github.com/actions/upload-pages-artifact?tab=readme-ov-file#artifact-validation">https://github.com/actions/upload-pages-artifact?tab=readme-ov-file#artifact-validation</a></li> <li>Pin <code>actions/upload-artifact</code> to SHA by <a href="https://github.com/heavymachinery"><code>@heavymachinery</code></a> in <a href="https://redirect.github.com/actions/upload-pages-artifact/pull/127">actions/upload-pages-artifact#127</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/upload-pages-artifact/compare/v3.0.1...v4.0.0">https://github.com/actions/upload-pages-artifact/compare/v3.0.1...v4.0.0</a></p> <h2>v3.0.1</h2> <h1>Changelog</h1> <ul> <li>Group tar's output to prevent it from messing up action logs <a href="https://github.com/SilverRainZ"><code>@SilverRainZ</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/94">#94</a>)</li> <li>Update README.md <a href="https://github.com/uiolee"><code>@uiolee</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/88">#88</a>)</li> <li>Bump the non-breaking-changes group with 1 update <a href="https://github.com/dependabot"><code>@dependabot</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/92">#92</a>)</li> <li>Update Dependabot config to group non-breaking changes <a href="https://github.com/JamesMGreene"><code>@JamesMGreene</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/91">#91</a>)</li> <li>Bump actions/checkout from 3 to 4 <a href="https://github.com/dependabot"><code>@dependabot</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/76">#76</a>)</li> </ul> <p>See details of <a href="https://github.com/actions/upload-pages-artifact/compare/v3.0.0...v3.0.1">all code changes</a> since previous release.</p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/actions/upload-pages-artifact/commit/7b1f4a764d45c48632c6b24a0339c27f5614fb0b"><code>7b1f4a7</code></a> Merge pull request <a href="https://redirect.github.com/actions/upload-pages-artifact/issues/127">#127</a> from heavymachinery/pin-sha</li> <li><a href="https://github.com/actions/upload-pages-artifact/commit/4cc19c7d3f3e6c87c68366501382a03c8b1ba6db"><code>4cc19c7</code></a> Pin <code>actions/upload-artifact</code> to SHA</li> <li><a href="https://github.com/actions/upload-pages-artifact/commit/2d163be3ddce01512f3eea7ac5b7023b5d643ce1"><code>2d163be</code></a> Merge pull request <a href="https://redirect.github.com/actions/upload-pages-artifact/issues/107">#107</a> from KittyChiu/main</li> <li><a href="https://github.com/actions/upload-pages-artifact/commit/c70484322b1c476728dcd37fac23c4dea2a0c51a"><code>c704843</code></a> fix: linted README</li> <li><a href="https://github.com/actions/upload-pages-artifact/commit/9605915f1d2fc79418cdce4d5fbe80511c457655"><code>9605915</code></a> Merge pull request <a href="https://redirect.github.com/actions/upload-pages-artifact/issues/106">#106</a> from KittyChiu/kittychiu/update-readme-1</li> <li><a href="https://github.com/actions/upload-pages-artifact/commit/e59cdfe6d6b061aab8f0619e759cded914f3ab03"><code>e59cdfe</code></a> Update README.md</li> <li><a href="https://github.com/actions/upload-pages-artifact/commit/a2d67043267d885050434d297d3dd3a3a14fd899"><code>a2d6704</code></a> doc: updated usage section in readme</li> <li><a href="https://github.com/actions/upload-pages-artifact/commit/984864e7b70fb5cb764344dc9c4b5c087662ef50"><code>984864e</code></a> Merge pull request <a href="https://redirect.github.com/actions/upload-pages-artifact/issues/105">#105</a> from actions/Jcambass-patch-1</li> <li><a href="https://github.com/actions/upload-pages-artifact/commit/45dc78884ca148c05eddcd8ac0a804d3365e9014"><code>45dc788</code></a> Add workflow file for publishing releases to immutable action package</li> <li><a href="https://github.com/actions/upload-pages-artifact/commit/efaad07812d4b9ad2e8667cd46426fdfb7c22e22"><code>efaad07</code></a> Merge pull request <a href="https://redirect.github.com/actions/upload-pages-artifact/issues/102">#102</a> from actions/hidden-files</li> <li>Additional commits viewable in <a href="https://github.com/actions/upload-pages-artifact/compare/v3...v4">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=actions/upload-pages-artifact&package-manager=github_actions&previous-version=3&new-version=4)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

#191) ## Overview This release introduces **automated test environment management** through `BeforeAll.ps1` and `AfterAll.ps1` scripts, enabling comprehensive setup and teardown capabilities for module tests running in GitHub Actions. This enhancement solves the challenge of managing complex test environments (databases, infrastructure, external services) across parallel test matrices while ensuring proper cleanup regardless of test outcomes. ### 🎯 Main Feature: Test Lifecycle Management #### The Problem Previously, setting up test infrastructure required: - Rate-limiting issue when creating GitHub Repositories for the GitHub PowerShell module, where the setup and teardown happens in the individual test files via BeforeAll and AfterAll blocks. #### The Solution **Dedicated setup and teardown jobs** with automatic script execution: - BeforeAll: Runs once before all test matrix jobs begin. - AfterAll: Runs once after all test matrix jobs complete. #### Configuration No configuration needed! Simply add scripts to your test directory. The workflow automatically detects and executes these scripts when present. ``` your-module/ ├── tests/ │ ├── BeforeAll.ps1 ← Setup script (optional) │ ├── AfterAll.ps1 ← Teardown script (optional) │ └── Module.Tests.ps1 ← The tests that require external setup │ ``` ### Additional: Specification-Driven Development Framework This release also includes an implementation of [spec-kit](https://github.com/github/spec-kit) principles, adding a structured workflow for feature development from specification through implementation. #### What's Included - **Prompt templates** (`.github/prompts/`) for `/specify`, `/clarify`, `/plan`, `/tasks`, `/analyze`, `/implement` commands - **Project constitution** (`.specify/memory/constitution.md`) defining architectural principles: ### Additional Workflow Improvements #### Linter Configuration Updates - Added `VALIDATE_BIOME_FORMAT: false` for Biome formatter - Added `VALIDATE_GITHUB_ACTIONS_ZIZMOR: false` for workflow security scanning - Added `VALIDATE_JSCPD: false` for copy-paste detection - Consistent linting configuration across Build-Docs and Linter workflows #### Test Workflow Enhancements - Environment variables properly scoped at workflow level - Clearer parameter naming (`OSName` vs `OS`) - Improved test execution coordination #### Documentation - Comprehensive setup/teardown guide in [README.md](README.md#setup-and-teardown-scripts) - Inline documentation in all prompt templates and scripts - Usage examples for common test scenarios --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

This release comprehensively improves documentation quality across the entire repository by fixing 21 instances of typos, grammatical errors, and formatting inconsistencies in 9 files. All changes enhance readability, professionalism, and clarity without any breaking changes or functionality modifications. ## Why These Changes Matter Documentation is the first point of contact for users and contributors. Unclear language, typos, and inconsistent formatting create friction and reduce confidence in the project. Poor documentation quality can lead to misunderstandings, incorrect implementations, and increased support burden. These improvements make the documentation more professional, scannable, and easier to understand for both new users and experienced contributors. ## How the Documentation Was Improved The improvements span three main categories: **Grammar & Language Clarity:** Fixed verb tense inconsistencies ("trigger" → "triggered"), corrected countable vs uncountable noun usage ("less" → "fewer"), added Oxford commas for better readability, improved sentence structure, and added missing articles throughout. **Formatting Standardization:** Standardized file references using inline code formatting (`` `BeforeAll.ps1` ``), converted mathematical notation to proper Unicode symbols (≤ instead of <=), improved list structures with consistent nested bullets, and enhanced visual hierarchy in workflow documentation. **Content Restructuring:** Reorganized test setup/teardown documentation for better flow, moved key information to prominent positions, eliminated redundant sections, integrated scattered information into main descriptions, and created clearer section divisions. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

## Description This pull request makes significant improvements to the documentation and prompt instructions for project workflows, especially around constitution management and implementation processes. The changes clarify modes of operation, add detailed step-by-step instructions, and ensure consistency and traceability across related files and workflows. **Key changes:** ### Constitution Management Enhancements * Expanded and clarified the instructions in `.github/prompts/constitution.prompt.md` to support both initial creation and iterative updating of the constitution, with detailed operating modes, placeholder handling, and replacement analysis for overlapping principles or rules. Added a Replacement Analysis Table, heuristics for overlap detection, and clear handling for ambiguous or destructive changes. [[1]](diffhunk://#diff-317e4feb1f303dde8c033746a25f6abd240d78d6fdb1ae80df86cfdf3c9cd8c5L2-R2) [[2]](diffhunk://#diff-317e4feb1f303dde8c033746a25f6abd240d78d6fdb1ae80df86cfdf3c9cd8c5L13-R55) * Improved the propagation and validation checklist for syncing changes across related templates and prompt files, using relative links and clarifying which files to update. Added explicit instructions for updating deprecated or pending sections and handling deferred actions. * Updated the description in `.github/prompts/constitution.prompt.md` to clarify the iterative nature of constitution updates. ### Implementation Workflow Improvements * Enhanced `.github/prompts/implement.prompt.md` with explicit support for both local and forked repository workflows, including detection of `.fork-info.json`, validation of fork configuration, and branch/PR management logic. [[1]](diffhunk://#diff-c7d6853d6175b556ba7b64b7764e390cbbb6e49f9b76e9102e979225f4910d4dL13-R19) [[2]](diffhunk://#diff-c7d6853d6175b556ba7b64b7764e390cbbb6e49f9b76e9102e979225f4910d4dR70-R151) * Added detailed instructions for iterative implementation: tracking task completion state in `tasks.md`, skipping completed tasks, resuming from the last incomplete task, and supporting multiple runs for refinement. * Added comprehensive steps for automated Pull Request creation/updating, including PR title/description formatting, label management, linking to issues, and fallback GitHub CLI commands for both local and fork workflows. * Included steps for updating issue labels and ensuring the constitution is updated to reflect implemented changes, with clear guidance on how to keep documentation in sync with codebase state. ### Documentation Consistency * Added a new `.github/instructions/md.instructions.md` file defining markdown style guidelines for consistent documentation across the repository, covering headings, lists, code blocks, links, tables, emphasis, whitespace, and more. These changes together provide clearer, more robust, and more maintainable workflows for both constitution management and implementation, ensuring consistency and traceability across documentation and project artifacts. - Constitution Management Enhancements: [[1]](diffhunk://#diff-317e4feb1f303dde8c033746a25f6abd240d78d6fdb1ae80df86cfdf3c9cd8c5L2-R2) [[2]](diffhunk://#diff-317e4feb1f303dde8c033746a25f6abd240d78d6fdb1ae80df86cfdf3c9cd8c5L13-R55) [[3]](diffhunk://#diff-317e4feb1f303dde8c033746a25f6abd240d78d6fdb1ae80df86cfdf3c9cd8c5L31-R97) - Implementation Workflow Improvements: [[1]](diffhunk://#diff-c7d6853d6175b556ba7b64b7764e390cbbb6e49f9b76e9102e979225f4910d4dL13-R19) [[2]](diffhunk://#diff-c7d6853d6175b556ba7b64b7764e390cbbb6e49f9b76e9102e979225f4910d4dR30-R41) [[3]](diffhunk://#diff-c7d6853d6175b556ba7b64b7764e390cbbb6e49f9b76e9102e979225f4910d4dR70-R151) - Documentation Consistency: ## Type of change  - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas

## Description This pull request updates the workflow prompts for the GitHub automation scripts to improve user communication and reporting. The main change is that each major phase (specification, clarification, planning, task generation, and analysis) now posts a clear status comment to the GitHub issue, summarizing progress and next steps for users. Additionally, the analysis and clarification steps now produce more structured, readable markdown reports. Key improvements include: **User Communication Enhancements:** * Each major workflow step (`specify`, `clarify`, `plan`, `tasks`, `analyze`) now posts a standardized status comment to the issue, clearly indicating completion and next recommended actions. [[1]](diffhunk://#diff-fa401fef0198b14e6b962bab378aefea7dac6156cbe91dc0ccf1f4de2a56e0fdL140-R142) [[2]](diffhunk://#diff-c0d19cb5a033f16f5989ac19b6c95af3bce61c8e84952ffb48009ed901264115L145-R162) [[3]](diffhunk://#diff-68a2c56959d80cc612e224742a5036c1110c7d7242c7970cea384847a63d2f74L141-R144) [[4]](diffhunk://#diff-dae60ede84de8dbfbeaa4633505d0c420ce25288ca04d74ac85b28454fad0734L112-R114) [[5]](diffhunk://#diff-149f5825020c21985a8967be1c77807826b4c395a3153ee54414ad90b862ffbbL97-R136) **Analysis and Clarification Reporting:** * The analysis step now posts a detailed markdown comment with tables grouped by severity, a summary, and explicit next actions, making findings easier to review and act upon. * The clarification step now posts a markdown summary table of questions and answers if any were asked, improving traceability of clarifications. **Process and Flow Improvements:** * The planning step now checks for clarifications before proceeding, pausing if ambiguous areas remain and instructing the user on how to resolve them. * Each phase's reporting is reorganized to ensure the status comment is posted before the detailed completion report, improving user guidance and flow. [[1]](diffhunk://#diff-fa401fef0198b14e6b962bab378aefea7dac6156cbe91dc0ccf1f4de2a56e0fdL140-R142) [[2]](diffhunk://#diff-68a2c56959d80cc612e224742a5036c1110c7d7242c7970cea384847a63d2f74L141-R144) [[3]](diffhunk://#diff-dae60ede84de8dbfbeaa4633505d0c420ce25288ca04d74ac85b28454fad0734L112-R114) These changes collectively make the workflow more transparent, actionable, and user-friendly. ## Type of change  - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas

## Description This pull request updates and clarifies the workflow instructions for planning and implementing features, with a strong focus on correct GitHub label management, improved documentation standards, and enhanced PR/release note formatting. The changes ensure that contributors follow standardized processes for labeling, documentation, and communication, making the workflow more consistent and user-friendly. **Workflow and Label Management Improvements:** * Both `.github/prompts/plan.prompt.md` and `.github/prompts/implement.prompt.md` now require setting and updating GitHub labels (like `Planning`, `Implementing`, `Specification`) at the start of each workflow, with clear instructions for both forked and local repositories. Fallback `gh` CLI commands are provided for manual updates. [[1]](diffhunk://#diff-68a2c56959d80cc612e224742a5036c1110c7d7242c7970cea384847a63d2f74L21-R53) [[2]](diffhunk://#diff-68a2c56959d80cc612e224742a5036c1110c7d7242c7970cea384847a63d2f74L117-R143) [[3]](diffhunk://#diff-c7d6853d6175b556ba7b64b7764e390cbbb6e49f9b76e9102e979225f4910d4dL19-R47) [[4]](diffhunk://#diff-c7d6853d6175b556ba7b64b7764e390cbbb6e49f9b76e9102e979225f4910d4dL98-R220) * The implementation workflow now includes immediate label transitions (e.g., removing `Planning` and adding `Implementing`), and the planning workflow adds/removes `Planning` and `Specification` as appropriate. [[1]](diffhunk://#diff-c7d6853d6175b556ba7b64b7764e390cbbb6e49f9b76e9102e979225f4910d4dL19-R47) [[2]](diffhunk://#diff-68a2c56959d80cc612e224742a5036c1110c7d7242c7970cea384847a63d2f74L21-R53) **Documentation and Formatting Standards:** * Added a new section in `.github/instructions/md.instructions.md` specifying that all requirement numbers (e.g., NFR-001, FR-042) must be formatted in bold and use non-breaking hyphens to prevent line breaks and ensure consistency in all documentation. * `.github/copilot-instructions.md` now mandates that all terminal commands in documentation be prefixed with `pwsh` (except for GitHub MCP calls), with examples provided for clarity. **PR and Release Note Guidance:** * The instructions for PR descriptions have been rewritten to require a user-focused, release-note style summary, with explicit sections for "What's Changed," "Usage," "Breaking Changes," and "Technical Notes." Example command-line instructions for updating PR descriptions are included. * The planning workflow now requires PRs to include both a version/change-level label (e.g., Major, Minor, Patch) and a phase label (Planning), with fallback CLI commands for label management. [[1]](diffhunk://#diff-68a2c56959d80cc612e224742a5036c1110c7d7242c7970cea384847a63d2f74L100-R120) [[2]](diffhunk://#diff-68a2c56959d80cc612e224742a5036c1110c7d7242c7970cea384847a63d2f74L117-R143) **Workflow Step Clarifications and Reordering:** * Both planning and implementation prompts have been restructured and renumbered for clarity, with explicit instructions for each step, including constitution and changelog updates, commit message standards, and final PR/issue updates. [[1]](diffhunk://#diff-c7d6853d6175b556ba7b64b7764e390cbbb6e49f9b76e9102e979225f4910d4dL39-R57) [[2]](diffhunk://#diff-c7d6853d6175b556ba7b64b7764e390cbbb6e49f9b76e9102e979225f4910d4dL48-R127) [[3]](diffhunk://#diff-68a2c56959d80cc612e224742a5036c1110c7d7242c7970cea384847a63d2f74L55-R83) **Changelog and Constitution Updates:** * The implementation workflow now explicitly requires updating both the constitution and the changelog with each feature or change, following best practices for documentation and release management. These changes collectively enforce best practices for workflow automation, documentation, and communication in the repository, improving clarity and consistency for all contributors. ## Type of change  - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas

## Description This pull request updates the implementation instructions in `.github/prompts/implement.prompt.md` to improve task tracking and clarify how pull request descriptions should be managed. The main focus is on making task progress more visible in real-time and ensuring the PR description is always ready to be used as release notes. **Task tracking and status updates:** * Added a critical requirement to update task status immediately after each task is completed: * Mark the task as `[X]` in `tasks.md` and update the PR description checkbox for each completed task. * Updates must be made task-by-task, not at the end. * Provided guidance for using GitHub tools or `gh pr edit` to update the PR description, ensuring real-time visibility of task progress. **Pull request description management:** * Changed instructions to require replacing the entire PR description with release notes: * The existing PR description, including the task list, must be cleared and replaced with release notes. * This ensures the PR description is immediately ready to be used as GitHub Release notes upon merging. * Updated the example command to clarify that the PR description should be replaced with release notes. ## Type of change  - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comparing changes

Open a pull request

Commits on Apr 19, 2025

Commits on Apr 20, 2025

Commits on May 1, 2025

Commits on May 20, 2025

Commits on Jun 1, 2025

Commits on Jun 2, 2025

Commits on Aug 19, 2025

Commits on Aug 27, 2025

Commits on Oct 1, 2025

Commits on Oct 2, 2025

This comparison is taking too long to generate.

Uh oh!