Fix escaped markdown in spec-change-impact PR comments#196
Merged
Conversation
Read comment body directly from file instead of through a shell variable, which was mangling markdown formatting (literal **bold**, broken lists).
Sensitive Change Detection (shadow mode)This PR modifies control-plane files:
|
There was a problem hiding this comment.
Pull request overview
This PR fixes markdown rendering in the “Spec Change Impact” PR comment posted by the spec-impact job by avoiding shell-variable/echo mangling and instead posting/updating directly from the generated response file.
Changes:
- Switch new-comment creation from
gh pr comment --body "$VAR"togh pr comment --body-file "$RESPONSE_FILE". - Switch comment updates from piping a shell variable into
jqto reading the body directly from the response file viajq -Rs . "$RESPONSE_FILE".
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
6 tasks
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.
Summary
$RESPONSE_FILEinstead of through a shell variable, which was mangling markdown (literal**, broken lists)--body "$VAR"→--body-file "$RESPONSE_FILE"echo "$VAR" | jq -Rs .→jq -Rs . "$RESPONSE_FILE"Test plan
spec/oropenapi.jsonand confirm the PR comment renders markdown correctly (bold, lists, checkboxes)Summary by cubic
Fixes mangled markdown in Spec Change Impact PR comments by reading the comment body from the response file instead of a shell variable. Bold text, lists, and checkboxes now render correctly.
jq -Rs . "$RESPONSE_FILE".--body-file "$RESPONSE_FILE"instead of--body "$COMMENT_BODY".Written for commit 386a321. Summary will update on new commits.