Repository navigation
Conversation
Closes github-community-projects#1124 Signed-off-by: lowlydba <lowlydba@users.noreply.github.com> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
There are no active review issues for the comment-template spacing change.
No open issues 🎉
What changed in this PR
This PR fixes Markdown formatting in generated comments by adding a blank line between the changes details block and the errors heading.
Changes:
- Adjusts the comment template’s spacing before “Breakdown of errors.”
- Adds a regression test that checks the rendered separator.
| File | Description |
|---|---|
test/unit/lib/commentmessage.test.js |
Verifies a blank line separates the details block from the errors heading. |
lib/commentmessage.js |
Adds the blank line to the comment template. |
Review effort: Balanced
This branch has not been deployed
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.
Closes #1124
The comment template emitted
</details>directly followed by### Breakdown of errors. GitHub's Markdown parser keeps a heading that abuts an HTML block inside that block, so the heading showed as literal text. Eta trims the newline after<%~ it.checkRunDetails %>, andcheckRunDetailshas no trailing newline of its own, so the template now adds a blank line after it.Rendered output before and after:
A unit test renders the template and asserts the blank line.