Skip to content

build: format the generated release docs with the latest prettier #7295

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.

Sign up for GitHub

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

Merged
andygrove merged 1 commit into from
Oct 28, 2026
Merged

build: format the generated release docs with the latest prettier #7295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion dev/generate-release-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,16 @@ done
# must pass the check. GenerateDocs wraps the config/cast tables in prettier-ignore, but
# the surrounding generated Markdown is not guaranteed prettier-clean. prettier honors
# .prettierignore, so excluded pages (e.g. expressions.md) are left untouched.
# CI installs the latest prettier (`npm install -g prettier`), and releases of prettier differ
# in what they accept, so format with the latest too rather than with whatever version is
# installed locally or cached by npx. Generating the 1.2.0 docs with prettier 3.2.5 left 40
# pages that the latest prettier rejects.
if ! command -v npx >/dev/null 2>&1; then
echo "ERROR: npx not found. Install Node/prettier (see docs/source/contributor-guide/development.md)" >&2
exit 1
fi
echo "Formatting generated Markdown with prettier..."
npx prettier "${LATEST_USER_GUIDE}/**/*.md" --write
npx --yes prettier@latest "${LATEST_USER_GUIDE}/**/*.md" --write

echo ""
echo "Done! Generated documentation content in docs/source/user-guide/latest/"
Expand Down
5 changes: 3 additions & 2 deletions docs/source/contributor-guide/release_process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,9 @@ git add docs/source/user-guide/latest/
git commit -m "Generate docs for 0.13.0 release"
```

The script runs one Maven build per supported Spark version, so it takes a while. Open a PR with this commit
targeting the release branch.
The script runs one Maven build per supported Spark version, so it takes a while. It formats the generated
pages with the latest prettier, which is what CI installs, so it needs network access to npm. Open a PR with this
commit targeting the release branch.

### Update Maven Version

Expand Down