CI: check translated languages and fail on warnings - #927
Merged
Merged
Conversation
GitHub warns that actions/checkout@v3 and actions/setup-python@v4 target Node.js 20, which is deprecated on the runners. Move checkout, setup-python and upload-artifact to their current majors, which run on Node.js 24.
ralf401
approved these changes
Sep 25, 2026
ralf401
left a comment
Contributor
There was a problem hiding this comment.
Nice, thanks! Question for my understanding: is it right that admin- and user docs have to get a check_translations: true flag afterwards?
Member
Author
|
yes right, this is an optional workflow step for now. I think it makes sense also because each documentation repo can define which translations to check (next to english) |
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.
Why
Broken markup in a translation only shows up when Sphinx builds that language. The shared workflow builds English only, so a Weblate PR can merge a translation like
and nobody notices until the rendered page shows a broken link or raw markup. Read the Docs does build the translated languages, but with
fail_on_warningdisabled it reports success anyway.What
docs.yml, the reusable workflow used by all three documentation repositories:check_translations(defaultfalse). For each language intranslation_languagesit runs the dummy builder with-W --keep-going, so warnings fail the job but every language is still built. The step ends with a compact list, one line per broken string, plus an error annotation each:actions/checkout,actions/setup-pythonandactions/upload-artifactmoved to their current majors (v7), which run on Node.js 24. GitHub warns about the Node.js 20 versions in every run.Verified
de,pt_BRandsrpass,itfails with exactly the one remaining broken string.