searxngRebrandZaclys/docs/dev/translation.rst

3.0 KiB

Translation

translated

Translation takes place on translate.codeberg.org.

Translations which has been added by translators on the translate.codeberg.org UI are committed to Weblate's counterpart of the SearXNG origin repository which is located at https://translate.codeberg.org/git/searxng/searxng.

There is no need to clone this repository, SearXNG Weblate workflow take care of the synchronization with the origin. To avoid merging commits from the counterpart directly on the master branch of SearXNG origin, a pull request (PR) is created by this workflow.

Weblate monitors the translations branch, not the master branch. This branch is an orphan branch, decoupled from the master branch (we already know orphan branches from the gh-pages). The translations branch contains only the

  • translation/messages.pot and the
  • translation/*/messages.po files, nothing else.
SearXNG's PR workflow to be in sync with Weblate
Sync from origin to weblate: using make weblate.push.translations

For each commit on the master branch of SearXNG origin the GitHub job babel / Update translations branch <.github/workflows/integration.yml> checks for updated translations.

Sync from weblate to origin: using make weblate.translations.commit

Every Friday, the GitHub workflow babel / create PR for additions from weblate <.github/workflows/translations-update.yml> creates a PR with the updated translation files:

  • translation/messages.pot,
  • translation/*/messages.po and
  • translation/*/messages.mo

wlc

All weblate integration is done by GitHub workflows, but if you want to use wlc, copy this content into wlc configuration in your HOME ~/.config/weblate

[keys]
https://translate.codeberg.org/api/ = APIKEY

Replace APIKEY by your API key.