-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCK-2428: Display markdown tables correctly #1827
Conversation
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## develop #1827 +/- ##
===========================================
+ Coverage 40.67% 40.68% +0.01%
===========================================
Files 364 364
Lines 11249 11251 +2
Branches 2866 2866
===========================================
+ Hits 4576 4578 +2
Misses 4377 4377
Partials 2296 2296
☔ View full report in Codecov by Sentry. |
WIll create ticket |
Would it work to replace each tab with four spaces, but just in the lines that start with |
Yeah, the tables would still render correctly since the tabs are removed (and this gets rid of the security hotspots which is good). The only thing is that tabs in other lines beginning with '|" would also be replaced with spaces, but that might not be too big of a concern if it's not very common. |
Kudos, SonarCloud Quality Gate passed! 0 Bugs 100.0% Coverage The version of Java (11.0.14.1) you have used to run this analysis is deprecated and we will stop accepting it soon. Please update to at least Java 17. |
Description
Some markdown tables do not render properly due to the presence of tab characters in the table. This PR removes tabs from table headers before parsing so that the html is generated correctly for the table.
Before:
After:
Review Instructions
Go to the info tab for a workflow with a table in the description (e.g., the workflow mentioned in the related ticket /workflows/github.com/aofarrel/tree_nine/tree_nine:main?tab=info) and make sure the table is displayed properly.
Issue
DOCK-2428
Security
If there are any concerns that require extra attention from the security team, highlight them here.
Please make sure that you've checked the following before submitting your pull request. Thanks!
npm run build
markdown-wrapper
component, which does extra sanitizationnpm audit
and ensure you are not introducing new vulnerabilities