v5.2.0
🚀[Feature]: Linting and Documentation Improvements with Conditional Summary Option (#226)
This pull request introduces improvements to the linting workflows and documentation, adds new configuration options for linter summary reporting, and updates test scripts for better visibility. The main focus is on allowing users to optionally display the super-linter summary even when no issues are found, and on clarifying documentation and prompts related to repository operations.
Workflow and Linter Enhancements:
- Added
ShowSummaryOnSuccessoption for both documentation and codebase linting workflows, allowing the super-linter summary to be displayed even on successful runs. Updated the workflows to post the summary conditionally based on this setting. (.github/workflows/Build-Docs.yml,.github/workflows/workflow.yml, [1] [2] [3] [4] [5] - Extended the settings parsing logic to support the new
ShowSummaryOnSuccessoption for bothBuild.DocsandLinterconfigurations. (.github/workflows/Get-Settings.yml, [1] [2]
Documentation Updates:
- Updated
README.mdto document the newShowSummaryOnSuccessoptions for both documentation and linter workflows, including example configuration and explanation of its usage. (README.md, [1] [2] [3] [4] [5] - Added a new section to
.github/copilot-instructions.mdfor process-related Copilot instructions.
Prompt and Command Improvements:
- Clarified execution steps in
.github/prompts/pr.prompt.mdto specify changing directory to the root of the attached git folder, and updated references to GitHub MCP tool commands to use simplified names. [1] [2]
Test Script Output Improvements:
- Changed test setup and teardown scripts (
BeforeAll.ps1,AfterAll.ps1) in both test repositories to useWrite-Warninginstead ofWrite-Hostfor better visibility of important messages. (tests/srcTestRepo/tests/BeforeAll.ps1, [1] [2];tests/srcTestRepo/tests/AfterAll.ps1, [3] [4];tests/srcWithManifestTestRepo/tests/BeforeAll.ps1, [5];tests/srcWithManifestTestRepo/tests/AfterAll.ps1, [6]