fix(rn-publish): convert markdown description to HTML via pandoc#39
Open
leanderdruwel-skyline wants to merge 1 commit into
Open
Conversation
The collaboration platform uses a rich-text editor (contenteditable div) that renders HTML. Previously, descriptions were sent as raw GitHub Flavored Markdown text, which caused: - Paragraph breaks (\n\n) to be invisible (all text bundles into one paragraph) - Markdown syntax (*italic*, \code\, **bold**) to appear literally Fix: pipe the extracted description through pandoc (pre-installed on ubuntu-latest) to convert GFM → HTML before sending to the API. This produces <p>, <em>, <code>, <strong>, <ul>/<li> tags that the platform renders correctly. Also adds a ::debug:: log line so the converted HTML is visible in the Actions run output for validation. Co-authored-by: Copilot <[email protected]>
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
1 participant
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.
Problem
The collaboration platform uses a rich-text editor (
contenteditablediv) that stores and renders HTML. The workflow was sending raw GitHub Flavored Markdown text, which caused two issues:\n\nbetween paragraphs is treated as whitespace in HTML, so all paragraphs run together as one block of text*italic*, backtick code,**bold**appear as literal characters instead of being renderedExample
The InfraOps RN had 3 paragraphs in the GitHub comment, but showed as one on collaboration.dataminer.services because the platform ignored the newline separators.
Fix
Pipe the extracted description through
pandoc(pre-installed onubuntu-latest) to convert GFM to HTML before sending to the API. This produces proper<p>,<em>,<code>,<strong>,<ul>/<li>tags that match what the platform expects.The
::debug::log line lets you verify the converted HTML in the Actions run output before trusting the result.