Skip to content

ci: fix docusaurus-mdx-checker installation #2913

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
anakin87 merged 5 commits into from
Mar 5, 2026
Merged

ci: fix docusaurus-mdx-checker installation #2913

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
af032ef
ci: fix broken docusaurus checker
anakin87 Mar 5, 2026
36492a9
Merge branch 'main' into broken-docusaurus-check
anakin87 Mar 5, 2026
bfde4aa
better comment
anakin87 Mar 5, 2026
d22ad7a
rm trigger
anakin87 Mar 5, 2026
317eef1
Merge branch 'broken-docusaurus-check' of https://github.com/deepset-…
anakin87 Mar 5, 2026
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
5 changes: 5 additions & 0 deletions .github/workflows/CI_check_api_ref.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,11 @@ jobs:
if: steps.changed.outputs.integrations != '[]'
working-directory: website
run: |
# docusaurus-mdx-checker is a package that is not frequently updated. Its dependency katex sometimes ships a
# broken ESM build, where a __VERSION__ placeholder is left unresolved, causing a ReferenceError at import time.
# Node 22+ prefers ESM when available. We force CJS (CommonJS) resolution to use the working katex build.
# This should be safe because docusaurus-mdx-checker and its dependencies provide CJS builds.
export NODE_OPTIONS="--conditions=require"
npx docusaurus-mdx-checker -v || {
echo ""
echo "For common MDX problems, see https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3#common-mdx-problems"
Expand Down