🚀[Feature]: Linting and Documentation Improvements with Conditional Summary Option #226
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds a workflow step intended to clear the GitHub Actions super-linter step summary after a successful run so later steps start with a clean summary.
- Adds a new step named "Clear super-linter summary"
- Uses Set-Content to truncate the $GITHUB_STEP_SUMMARY file
- Includes an explicit if: success() condition
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Deleted `create-new-feature.ps1`, `setup-plan.ps1`, and `update-agent-context.ps1` scripts as they are no longer needed. - Removed associated templates: `agent-file-template.md`, `constitution-template.md`, `plan-template.md`, `spec-template.md`, and `tasks-template.md`. - This cleanup helps streamline the project by eliminating unused code and templates.
…AfterAll scripts for better logging
…File for better compatibility
…failure and failing the job if issues are found
Contributor
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 27 out of 27 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (2)
tests/srcTestRepo/tests/BeforeAll.ps1:1
- [nitpick] These messages describe normal informational progress, but Write-Warning elevates them to warnings which can create noise or imply problems in CI logs. Use Write-Host (for purely cosmetic output) or preferably Write-Verbose/Write-Information with CmdletBinding and -Verbose support to distinguish normal progress from actual warnings.
Write-Warning "=== BEFOREALL SETUP SCRIPT EXECUTING ==="
…ve error reporting
…treamline workflow
…step to ensure compatibility
…n planning - Created `create-new-feature.ps1` to automate feature branch creation and spec file generation. - Added `setup-plan.ps1` for setting up implementation plans based on feature specifications. - Introduced `update-agent-context.ps1` to update agent context files with plan data. - Developed templates for agent files, constitutions, implementation plans, and feature specifications. - Implemented task generation template to streamline task planning for feature execution.
…n planning - Created `create-new-feature.ps1` to automate the creation of new feature branches and directories. - Added `setup-plan.ps1` for setting up implementation plans for features. - Introduced `update-agent-context.ps1` to update agent context files based on plan data. - Added templates for agent files, constitutions, implementation plans, feature specifications, and tasks. - Implemented structured templates to standardize feature documentation and task generation processes.
…rce stricter error handling
tests/srcWithManifestTestRepo/src/functions/public/Test-PSModuleTest.ps1
Outdated
Show resolved
Hide resolved
… Test-PSModuleTest function description to remove extraneous text
…orkspace management
…better compatibility
…ibility; adjust super-linter environment variable to use FILTER_REGEX_EXCLUDE
… for improved path handling
MariusStorhaug
force-pushed
the
clearSummary
branch
from
43685f7 to
97bc571
Compare
… path filtering; add duplicate header in README.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
MariusStorhaug
changed the title
MariusStorhaug
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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]ShowSummaryOnSuccessoption for bothBuild.DocsandLinterconfigurations. (.github/workflows/Get-Settings.yml, [1] [2]Documentation Updates:
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].github/copilot-instructions.mdfor process-related Copilot instructions.Prompt and Command Improvements:
.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:
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]