Skip to content

Maintenance: check translated languages in CI. - #1323

Merged
suelje merged 1 commit into
zammad:pre-releasefrom
suelje:check-translations
Sep 28, 2026
Merged

suelje merged 1 commit into
zammad:pre-releasefrom
suelje:check-translations

Conversation

@suelje

@suelje suelje commented Sep 25, 2026

Copy link
Copy Markdown
Member

CI: check translated languages

Why

The shared documentation workflow builds English only. A translation that breaks the markup of its source string, for example a translated :doc: target, passes CI and only shows up after the Weblate PR is merged, as a broken link or raw markup on the rendered page. Read the Docs builds the translated languages but reports success regardless of warnings, so the breakage stays silent. See coordination-scrum #1756.

What

test.yml opts in to the new check_translations input of the shared workflow (zammad/zammad-documentation, see the corresponding PR there). The workflow then builds de, it, pt_BR and sr, the languages published on Read the Docs, with warnings treated as errors and lists the broken strings at the end of the job:

Broken translations, fix these strings in Weblate:
  it: system/objects/external-data-source-example.rst:235: WARNING: unknown document: tipi

Each line is also reported as an error annotation. A Weblate PR with a broken translation fails before merge instead of after deployment. Nothing else changes; English is still built as before.

Depends on

zammad/zammad-documentation PR "CI: check translated languages and fail on warnings". It has to be merged to pre-release first, otherwise the check_translations input is unknown and the workflow call fails.

Verified

Tested against a fork pointing at the fork's copy of the shared workflow: de, pt_BR and sr pass, it fails with the one string above, the job ends with the list shown.

@suelje
suelje marked this pull request as ready for review September 25, 2026 13:19
@suelje
suelje requested a review from ralf401 September 25, 2026 13:19

@ralf401 ralf401 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! To have CI green, we have to fix the one Italian string by overwriting it hard, because this is no Weblate PR, right?

@suelje

suelje commented Sep 25, 2026

Copy link
Copy Markdown
Member Author

I fixed the Italian string and would now simply wait for the change to be merged. Then afterwards, this CI will become green and we can merge it on top, right?

@ralf401

ralf401 commented Sep 28, 2026

Copy link
Copy Markdown
Contributor

Yeah makes sense. I'll merge the other Weblate translation PRs now.

@suelje
suelje merged commit 52cb347 into zammad:pre-release Sep 28, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants