Repository navigation
build: format the generated release docs with the latest prettier - #7295
Merged
Merged
Conversation
manuzhang
approved these changes
Oct 28, 2026
sunchao
approved these changes
Oct 28, 2026
sunchao
left a comment
Member
There was a problem hiding this comment.
Reviewed 79bcb186519ef73c13fb3e3575a6e16e2b63f2d2 across five independent scopes. No actionable findings. The explicit prettier@latest matches CI's existing install policy, preserves the generated-page scope, and the release guide documents the network requirement.
bash -n dev/generate-release-docs.sh passed. Current-head preflight and Required Checks are green. I did not rerun the full multi-profile documentation build.
Member
Author
|
Thanks @manuzhang @sunchao |
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
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.
Which issue does this PR close?
Part of #6550. Found while generating the 1.2.0 release docs (#7292).
Rationale for this change
dev/generate-release-docs.shformats the generated pages withnpx prettier, which runs whichever prettier version is installed locally or cached. CI runsprettier --check "**/*.md"with the latest prettier (npm install -g prettier). The two disagreed on the 1.2.0 docs. Generated with prettier 3.2.5, 40 of the compatibility pages failed the CI check under 3.9.10, because the newer version wants a blank line before<!--END:EXPR_COMPAT-->after a list. The fix on #7292 was a second commit that added that line to each page.What changes are included in this PR?
dev/generate-release-docs.shrunsnpx --yes prettier@latest, the same version CI installs, with a comment that says why.docs/source/contributor-guide/release_process.mdnotes that the script formats with the latest prettier and so needs network access to npm.How are these changes tested?
bash -npasses on the script. I rannpx --yes prettier@latest --checkover the generated pages on the 1.2.0 docs branch before and after the fix. It reported 40 files before and none after. I did not rerun the whole script with this change, because it runs five Maven builds.