arduino / report-size-deltas

GitHub Actions action that comments on pull requests with a report of change in memory usage of Arduino sketches
Other
14 stars 8 forks source link

Prevent unintended rendering of report content #32

Closed per1234 closed 1 year ago

per1234 commented 1 year ago

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 :mega: markup for the :mega: 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 fence" markup, the introduction of this markup into that part of the report is unnecessary.

codecov-commenter commented 1 year ago

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (239ce6d) 100.00% compared to head (5cbb096) 100.00%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #32 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 2 2 Lines 726 732 +6 ========================================= + Hits 726 732 +6 ``` | [Impacted Files](https://codecov.io/gh/arduino/report-size-deltas/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino) | Coverage Δ | | |---|---|---| | [reportsizedeltas/tests/test\_reportsizedeltas.py](https://codecov.io/gh/arduino/report-size-deltas/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino#diff-cmVwb3J0c2l6ZWRlbHRhcy90ZXN0cy90ZXN0X3JlcG9ydHNpemVkZWx0YXMucHk=) | `100.00% <ø> (ø)` | | | [reportsizedeltas/reportsizedeltas.py](https://codecov.io/gh/arduino/report-size-deltas/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino#diff-cmVwb3J0c2l6ZWRlbHRhcy9yZXBvcnRzaXplZGVsdGFzLnB5) | `100.00% <100.00%> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.