Проверка переводов в GitLab CI

Задача

Добавьте его в .gitlab-ci.yml. Измените --source на файл вашего базового языка и --langs на локали, которые вы поставляете. Блок rules запускает задачу только для запросов на слияние, которые изменяют что-либо в locales/; удалите строки changes, чтобы запускать ее для каждого запроса на слияние.

i18n-check:
  stage: test
  image: python:3.12-slim
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
      changes:
        - locales/**/*
  script:
    - pip install kaeris
    - kaeris check --source locales/en.json --langs de,fr --ci

Что выводит задача

Две строки script, выполненные по порядку. Слева: файлы, которые в порядке. Справа: de.json с {nam} вместо {name} и отсутствующим ключом checkout; задача останавливается с кодом выхода 1.

$ pip install kaeris
Collecting kaeris
  Using cached kaeris-0.2.35-py3-none-any.whl.metadata (26 kB)
Using cached kaeris-0.2.35-py3-none-any.whl (131 kB)
Installing collected packages: kaeris
Successfully installed kaeris-0.2.35

$ kaeris check --source locales/en.json --langs de,fr --ci
✓ de: complete & placeholder-safe
✓ fr: complete & placeholder-safe
✓ all locales complete & placeholder-safe
Job succeeded
exit code: 0

$ pip install kaeris
Requirement already satisfied: kaeris in C:\Users\Inzagi\AppData\Local\Temp\claude\C--Users-Inzagi-projects-kaeris\bfeebe69-3cfd-4f28-bbe7-e5600be082b9\scratchpad\venv-gl2\Lib\site-packages (0.2.35)

$ kaeris check --source locales/en.json --langs de,fr --ci
✗ de: 1 missing key(s): checkout
✗ de: 1 placeholder mismatch(es):
    greeting: missing ['{name}'], added ['{nam}']
✗ de: 2 translation fault(s):
    greeting: lost placeholder {name}
    greeting: invented placeholder {nam} (not in source)
✓ fr: complete & placeholder-safe
✗ 1 missing key, 1 placeholder mismatch, 2 translation faults
ERROR: Job failed: exit code 1
exit code: 1

1. Добавьте задание

   Вставьте задание в .gitlab-ci.yml и укажите свои --source и --langs.

2. Откройте merge request

   Измените файл локали в ветке и откройте merge request. Задание выполнится и покажет все найденные проблемы в своем журнале.

3. Требуйте прохождения пайплайна

   В настройках проекта в разделе merge requests включите требование успешного прохождения пайплайнов. Красное задание тогда заблокирует слияние.

• Что выполнилось

  Обе строки script, взятые из разобранного YAML, выполнялись одна за другой в чистом виртуальном окружении Python, останавливаясь на первой неудачной строке, как это делает задание GitLab. pip install kaeris загрузил kaeris 0.2.35 из PyPI. Чистые файлы: код выхода 0. Поврежденный de.json: код выхода 1.

• Что не выполнилось

  Не использовался ни GitLab runner, ни Docker-образ (журнал выше получен с ПК с Windows и Python 3.14, а не из python:3.12-slim). Блок rules и changes был только разобран как YAML; GitLab его не вычислял. Пакет требует Python 3.8 или новее.

• Считать устаревшие ключи ошибкой

  --strict также выдает ошибку, когда в переводе есть ключи, которых больше нет в исходном файле.

• Сохраняйте названия брендов как написано

  --glossary 'KAERIS,GitHub' приведет к сбою цели, которая упустила один из терминов. Тот же список может находиться в разделе keep в kaeris.json.

• Другая структура файлов

  --out — это папка с переводами, а --pattern '{lang}/common.json' — их имена файлов. По умолчанию: структура, которую записывает kaeris translate.

• Без флагов вообще

  При наличии файла kaeris.json в проекте (kaeris init записывает его), kaeris check берет исходный файл, языки и папку из него.

Другие рецепты: GitHub Actions · pre-commit · Make и npm скрипты

Справочник по CLI · Справочник по проверке · Справочник по GitHub Action · Бесплатная проверка в браузере · Перевод в браузере