Skip to content

v5.2.0

Choose a tag to compare

@github-actions github-actions released this 08 Oct 20:25
· 6 commits to main since this release
ea29e6b

🚀[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 ShowSummaryOnSuccess option 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 ShowSummaryOnSuccess option for both Build.Docs and Linter configurations. (.github/workflows/Get-Settings.yml, [1] [2]

Documentation Updates:

  • Updated README.md to document the new ShowSummaryOnSuccess options 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.md for process-related Copilot instructions.

Prompt and Command Improvements:

  • Clarified execution steps in .github/prompts/pr.prompt.md to 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 use Write-Warning instead of Write-Host for 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]