Configuração
Configure a Localização contínua no GitHub, GitLab ou Bitbucket. Há duas opções compatíveis: o GitHub App da Lingo.dev, na versão gerenciada, ou a execução de @lingo.dev/cli no seu próprio pipeline. Escolha a que melhor combina com sua plataforma e com o nível de controle que você precisa.
Qual opção devo usar?#
| Opção | Ideal para | O que você precisa |
|---|---|---|
| GitHub App | Repositórios hospedados no GitHub | Instale o app e faça commit de .lingo/config.json com um engineId. Sem runner, secret nem CLI. |
@lingo.dev/cli em um runner | GitLab, Bitbucket ou GitHub Actions, se você quiser controle total | Node 22+, @lingo.dev/cli, um secret LINGO_API_KEY e um job que execute lingo push. |
Está no GitHub? Comece pelo GitHub App
O GitHub App roda no servidor. Ele lê um .lingo/config.json versionado (incluindo seu engineId), responde a pushes e pull requests e não exige runner, secret de API nem lock file. Basta seguir o guia do GitHub App — o restante desta página mostra como executar a CLI no seu próprio pipeline.
Executando a CLI no seu pipeline#
Se você usa GitLab ou Bitbucket, ou prefere controlar a localização diretamente no GitHub, execute @lingo.dev/cli como um job no seu pipeline. A configuração é a mesma em qualquer plataforma e segue três etapas: configurar a CLI, adicionar sua chave de API e escolher um workflow.
Pré-requisitos
Antes de adicionar isso ao CI, você precisa ter uma configuração funcional da CLI, com um arquivo .lingo/config.json, e conseguir executar lingo push localmente.
Etapa 1. Configure a CLI#
Se ainda não fez isso, siga o Quickstart da CLI. Ao final, você deve ter:
- Um arquivo
.lingo/config.jsonna raiz do projeto (consulte Configuration) - Um
LINGO_API_KEYpara o Engine de localização da Lingo.dev - A capacidade de gerar traduções localmente com
lingo push
A CLI roda em Node 22+. Instale-a no seu pipeline com:
npm install -g @lingo.dev/cliEtapa 2. Adicione sua chave de API como segredo no CI#
lingo push se autentica com a variável de ambiente LINGO_API_KEY. Armazene-a no gerenciador de secrets da sua plataforma de CI:
- Acesse Settings > Secrets and variables > Actions
- Clique em New repository secret
- Nome:
LINGO_API_KEY, Valor: sua chave de API - Clique em Add secret
Etapa 3. Escolha um workflow e adicione a configuração#
Seu job executa lingo push para gerar traduções e, em seguida, faz commit do resultado ou abre um pull request usando as ferramentas da própria plataforma. Escolha o workflow que melhor funciona para a sua equipe:
| Workflow | Ideal para |
|---|---|
| Commit na main | Equipes pequenas que querem atualizações de tradução invisíveis e sem atrito |
| PR a partir da main | Equipes que querem fazer revisão das traduções antes de enviar para a main |
| Commit na branch de feature | Equipes com branches de feature de longa duração |
| PR a partir da branch de feature | Equipes que querem o máximo de controle sobre cada mudança de tradução |
Não sabe qual escolher? Comece com "Commit na main" — é a opção mais simples. Você pode mudar depois sem alterar seu .lingo/config.json.
Para ver instruções de configuração por plataforma e exemplos de workflow, consulte:
Verifique a configuração#
Depois de configurar seu job de CI, envie uma alteração para acioná-lo. O pipeline deve:
- Executar
lingo pushpara traduzir conteúdo novo e alterado - Fazer commit das traduções ou abrir um PR, dependendo do workflow
- Atualizar o arquivo
.lingo/lock.json, que registra o que já foi traduzido
Para verificar no CI se as traduções estão completas sem gerar novas, execute lingo check:
lingo checkIsso retorna um status diferente de zero se houver qualquer conteúdo sem tradução — útil como bloqueio de deploy. Consulte Padrões Avançados para ver exemplos.