Настройте непрерывную локализацию на GitHub, GitLab или Bitbucket. Поддерживаются два варианта: управляемое приложение Lingo.dev GitHub App и запуск @lingo.dev/cli в собственном пайплайне. Выберите тот, что подходит вашей платформе и нужному уровню контроля.
Какой вариант выбрать?#
| Вариант | Лучше всего подходит для | Что нужно |
|---|---|---|
| GitHub App | Репозитории на GitHub | Установите приложение, зафиксируйте .lingo/config.json с engineId. Раннер, секреты и CLI не нужны. |
@lingo.dev/cli в раннере | GitLab, Bitbucket или GitHub Actions — если нужен полный контроль | Node 22+, @lingo.dev/cli, секрет LINGO_API_KEY и задание, которое запускает lingo push. |
Работаете на GitHub? Начните с GitHub App
GitHub App работает на стороне сервера. Он читает зафиксированный .lingo/config.json (включая engineId), реагирует на пуши и pull request'ы и не требует раннера, секрета с API-ключом или lock-файла. Следуйте руководству по GitHub App — и готово. Остальная часть страницы посвящена запуску CLI в собственном пайплайне.
Запуск CLI в пайплайне#
Если вы работаете на GitLab или Bitbucket, или хотите управлять локализацией самостоятельно на GitHub — запустите @lingo.dev/cli как задание в пайплайне. Настройка одинакова на всех платформах и состоит из трёх шагов: настройте CLI, добавьте API-ключ и выберите рабочий процесс.
Что понадобится
Прежде чем добавлять CLI в CI, убедитесь, что у вас есть рабочая настройка CLI с файлом .lingo/config.json и возможность запускать lingo push локально.
Шаг 1. Настройте CLI#
Если вы ещё не сделали этого, следуйте Быстрому старту CLI. В итоге у вас должно быть:
- Файл
.lingo/config.jsonв корне проекта (см. Конфигурация) LINGO_API_KEYдля движка Lingo.dev- Возможность локально генерировать переводы с помощью
lingo push
CLI работает на Node 22+. Установите его в пайплайне:
npm install -g @lingo.dev/cliШаг 2. Добавьте API-ключ в секреты CI#
lingo push проходит аутентификацию через переменную окружения LINGO_API_KEY. Сохраните её в системе управления секретами вашей CI-платформы:
- Перейдите в Settings > Secrets and variables > Actions
- Нажмите New repository secret
- Имя:
LINGO_API_KEY, значение: ваш API-ключ - Нажмите Add secret
Шаг 3. Выберите рабочий процесс и добавьте конфигурацию#
Задание запускает lingo push, чтобы сгенерировать переводы, а затем фиксирует результат или открывает pull request с помощью инструментов платформы. Выберите рабочий процесс, который подходит вашей команде:
| Рабочий процесс | Лучше всего подходит для |
|---|---|
| Commit в main | Небольших команд, которым нужны незаметные обновления переводов без лишних действий |
| PR из main | Команд, которые хотят проверять переводы до попадания в main |
| Commit в feature branch | Команд с долгоживущими feature branch |
| PR из feature branch | Команд, которым нужен максимальный контроль над каждым изменением перевода |
Не уверены, что выбрать? Начните с "Commit в main" — это самый простой вариант. Позже вы сможете переключиться, не меняя свой .lingo/config.json.
Инструкции по настройке для конкретных платформ и примеры рабочих процессов смотрите здесь:
Проверьте настройку#
После настройки CI-задания сделайте пуш, чтобы запустить его. Пайплайн должен:
- Запустить
lingo push, чтобы перевести новый и изменённый контент - Закоммитить переводы или открыть PR — в зависимости от выбранного рабочего процесса
- Обновить файл
.lingo/lock.json, который отслеживает уже переведённое
Чтобы проверить полноту переводов в CI без генерации новых, запустите lingo check:
lingo checkКоманда завершится с ненулевым статусом, если какой-то контент останется непереведённым. Это удобно использовать как барьер для деплоя. Примеры смотрите в разделе Продвинутые сценарии.
