Prevent unintended rendering of report content #32
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
The report is made in the form of GitHub PR comment. These comments are rendered according to the "GitHub Flavored Markdown" markup language. In addition to the intentional markup used to format the report, the uncontrolled strings of the report content might contain incidental markup. Previously, this would cause the report to be rendered incorrectly. For example, the FQBN `arduino:avr:mega:cpu=atmega2560` contains the markup for the megaphone emoji, so was rendered incorrectly: > arduino:avr📣cpu=atmega2560 The solution is to wrap the uncontrolled strings in the Markdown "code span" markup. Since the entire CSV format report is already wrapped in the equivalent "code fences" markup, the introduction of this markup into that part of the report is unnecessary.
per1234
added
type: imperfection
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #32 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 726 732 +6
=========================================
+ Hits 726 732 +6
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
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.
The report is made in the form of GitHub PR comment. These comments are rendered according to the "GitHub Flavored Markdown" markup language.
In addition to the intentional markup used to format the report, the uncontrolled strings of the report content might contain incidental markup. Previously, this would cause the report to be rendered incorrectly.
For example, the FQBN
arduino:avr:mega:cpu=atmega2560contains the:mega:markup for the 📣 emoji, so was rendered incorrectly:The solution is to wrap the uncontrolled strings in the Markdown "code span" markup.
Since the entire CSV format report is already wrapped in the equivalent "code fence" markup, the introduction of this markup into that part of the report is unnecessary.