Harden external plugin gate comment output safety#2265
Merged
aaronpowell merged 2 commits intoJul 10, 2026
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR hardens the external plugin PR quality-gates workflow’s generated issue comment content to reduce the risk of malformed rendering and failures caused by unsafe characters and large gate outputs.
Changes:
- Added HTML escaping for gate detail summaries and gate output content.
- Switched gate output rendering from fenced Markdown code blocks to
<pre><code>HTML blocks inside<details>. - Introduced per-gate output truncation with a truncation marker.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/external-plugin-pr-quality-gates.yml |
Escapes and re-renders gate detail output, and introduces truncation to keep gate output bounded. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Low
Comment on lines
+211
to
+219
| const truncateGateOutput = (rawOutput) => { | ||
| const normalized = String(rawOutput || '').trim(); | ||
| if (!normalized) { | ||
| return '_No output captured._'; | ||
| } | ||
| if (normalized.length <= MAX_GATE_OUTPUT_CHARS) { | ||
| return normalized; | ||
| } | ||
| return `${normalized.slice(0, MAX_GATE_OUTPUT_CHARS)}\n...output truncated...`; |
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
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
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.
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.mainbranch for this pull request.Description
This follow-up hardens external plugin PR quality comment rendering to avoid malformed comments and oversized payload failures when plugin names or gate output contain unsafe characters or very large content.
The workflow now escapes HTML for summary and output content, renders gate details with
<pre><code>blocks instead of fenced backticks, and truncates gate output to a bounded length with an explicit truncation marker.Type of Contribution
Additional Notes
Scope is intentionally narrow: only
.github/workflows/external-plugin-pr-quality-gates.ymlwas updated.By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.