🐛 fix(docs): strip HTML comments from generated changelog MDX#434
Closed
scttbnsn wants to merge 1 commit into
Closed
🐛 fix(docs): strip HTML comments from generated changelog MDX#434scttbnsn wants to merge 1 commit into
scttbnsn wants to merge 1 commit into
Conversation
sync-docs.mjs copied CHANGELOG.md verbatim into the fumadocs MDX source. The <!-- ... --> maintainer note in the [Unreleased] section is valid in the GitHub-rendered CHANGELOG but MDX v3 rejects HTML comments, failing the Turbopack build (drydock-website production + preview deploys erroring since 2026-06-13). Strip HTML comments during generation (they are not published-docs content) and collapse the resulting blank-line gap. CHANGELOG.md stays GitHub-valid and unchanged.
scttbnsn
requested review from
ALARGECOMPANY and
biggest-littlest
as code owners
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+35
to
+37
| const body = changelogMd | ||
| .replace(/^# Changelog\n/, "") | ||
| .replace(/<!--[\s\S]*?-->/g, "") |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
biggest-littlest
approved these changes
Jun 15, 2026
biggest-littlest
left a comment
biggest-littlest
left a comment
Member
There was a problem hiding this comment.
Approved: build-time docs generator fix to strip HTML comments from the generated changelog MDX. Unblocks the drydock-website production deploy. Required checks green; E2E correctly path-skipped for a docs-only change.
ALARGECOMPANY
approved these changes
Jun 15, 2026
ALARGECOMPANY
left a comment
ALARGECOMPANY
left a comment
Member
There was a problem hiding this comment.
Second code-owner approval. Fix is scoped to apps/web/scripts/sync-docs.mjs; output verified to contain no residual HTML comments.
Contributor
Author
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
4 participants
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
Every
drydock-websiteVercel deploy (production + preview) has failed since ~2026-06-13:sync-docs.mjscopiesCHANGELOG.mdverbatim into the fumadocs MDX source. The<!-- ... -->upgrade-notes maintainer note in the[Unreleased]section is valid in the GitHub-rendered CHANGELOG but MDX v3 rejects HTML comments, failing the build. getdrydock.com production has been stuck on the last good build for ~2 days.Fix
Strip HTML comments during MDX generation (they are maintainer-only notes, not published-docs content) and collapse the blank-line gap.
CHANGELOG.mdstays GitHub-valid and unchanged. Root-cause fix in the generator, so future CHANGELOG comments can't break the build.Verification
node apps/web/scripts/sync-docs.mjs→ generatedv1.5/changelog/index.mdxhas 0<!--.npm run buildinapps/webpasses (240+ docs pages generated incl. changelog).1 file changed, 9 insertions(+), 1 deletion(-).