Configure a Localização Contínua no GitHub, GitLab ou Bitbucket. Existem duas opções suportadas: a GitHub App da Lingo.dev, gerida, e a execução de @lingo.dev/cli no seu próprio pipeline. Escolha a que melhor se adapta à sua plataforma e ao nível de controlo que pretende.
Que opção devo escolher?#
| Opção | Ideal para | Requisitos |
|---|---|---|
| GitHub App | Repositórios alojados no GitHub | Instale a app e faça commit de .lingo/config.json com um engineId. Sem runner, secret nem CLI. |
@lingo.dev/cli num runner | GitLab, Bitbucket ou GitHub Actions, se quiser controlo total | Node 22+, @lingo.dev/cli, um secret LINGO_API_KEY e um job que execute lingo push. |
No GitHub? Comece pela GitHub App
A GitHub App corre no servidor. Lê um .lingo/config.json com commit feito (incluindo o seu engineId), reage a pushes e pull requests, e não precisa de runner, secret da chave API nem lock file. Siga o guia da GitHub App e fica pronto — o resto desta página explica como executar a CLI no seu próprio pipeline.
Executar a CLI no seu pipeline#
Se usa GitLab ou Bitbucket, ou se quer gerir a localização diretamente no GitHub, execute @lingo.dev/cli como um job no seu pipeline. A configuração é igual em todas as plataformas: configurar a CLI, adicionar a sua chave API e escolher um workflow.
Pré-requisitos
Antes de a adicionar ao CI, precisa de ter uma configuração funcional da CLI, com um ficheiro .lingo/config.json, e conseguir executar lingo push localmente.
Passo 1. Configurar a CLI#
Se ainda não o fez, siga o Quickstart da CLI. No final, deverá ter:
- Um ficheiro
.lingo/config.jsonna raiz do projeto (consulte Configuration) - Uma
LINGO_API_KEYpara o Motor de Localização da Lingo.dev - A capacidade de gerar traduções localmente com
lingo push
A CLI funciona com Node 22+. Instale-a no seu pipeline com:
npm install -g @lingo.dev/cliPasso 2. Adicione a sua chave de API como secret de CI#
lingo push autentica-se através da variável de ambiente LINGO_API_KEY. Guarde-a na gestão de secrets da sua plataforma de CI:
- Aceda a Settings > Secrets and variables > Actions
- Clique em New repository secret
- Nome:
LINGO_API_KEY, Valor: a sua chave de API - Clique em Add secret
Passo 3. Escolha um workflow e adicione a configuração#
O seu job executa lingo push para gerar traduções e depois faz commit do resultado ou abre um pull request com as ferramentas da própria plataforma. Escolha o workflow que melhor se adapta à sua equipa:
| Workflow | Melhor para |
|---|---|
| Commit para a main | Equipas pequenas que querem atualizações de tradução sem atrito e sem intervenção |
| PR a partir da main | Equipas que querem rever as traduções antes de chegarem à main |
| Commit para branch feature | Equipas com branches feature de longa duração |
| PR a partir de branch feature | Equipas que querem o máximo de controlo sobre cada alteração de tradução |
Não tem a certeza de qual escolher? Comece por "Commit para a main" — é a opção mais simples. Pode mudar mais tarde sem alterar o seu .lingo/config.json.
Para instruções de configuração específicas por plataforma e exemplos de workflow, consulte:
Verificar a configuração#
Depois de configurar o job de CI, faça push de uma alteração para o acionar. O pipeline deverá:
- Executar
lingo pushpara traduzir conteúdo novo e alterado - Fazer commit das traduções ou abrir um PR (consoante o workflow)
- Atualizar o ficheiro
.lingo/lock.json, que regista o que já foi traduzido
Para confirmar no CI que as traduções estão completas sem gerar novas, execute lingo check:
lingo checkIsto termina com um estado diferente de zero se existir conteúdo por traduzir — útil como gate de deployment. Consulte Advanced Patterns para ver exemplos.
