Integração GitLab

A integração com o GitLab sincroniza arquivos de origem e tradução entre o repositório do GitLab e o projeto de tradução no Crowdin. All translated and approved files will be automatically pushed as a merge request to the l10n branch in the GitLab repository.

Conectando o GitLab ao Crowdin

Existem duas opções possíveis para você escolher. You can either use your GitLab account or GitLab Enterprise account.

Conectando à sua conta GitLab

1. Open your project and go to the Applications tab.
2. Click on GitLab in the Applications list.
3. Click Set Up Integration to integrate via your GitLab account.
4. Then authorize the connection with Crowdin on the GitLab side:

Conectando a conta corporativa do GitLab

1. To integrate via GitLab Enterprise account you should create an access token. Certifique-se de selecionar os escopo necessário:

   • api – Concede acesso completo de leitura/gravação à API, incluindo todos os grupos e projetos, o registro de contêiner e o registro de pacotes

     Note: When setting up an integration with an access token, ensure that you have the Maintainer level permission to the necessary repo.
2. Click on the GitLab Enterprise in the Applications list.
3. Em seguida, insira seu token de acesso e URL base nos campos correspondentes. Clique em Configurar Integração para continuar.

Selecting Repository

In the appeared dialog, select your repository and branches that should be translated. It’s recommended to switch Duplicate Strings to Show within a version branch, so identical strings will be hidden between branches. If your source files contain strings with apparent identifiers (keys), it’s better to use a strict version of this option. Em outros casos, sinta-se à vontade para usar uma normal.

Leia mais sobre Textos duplicados.

When you work with private integrations (e.g., integrations with self-hosted VCS), you need to add dedicated Crowdin IP addresses to the allowlist to ensure that it operates properly while staying secure.

Read more about IP Addresses.

Serviço de ramos

When translations are finished and your languages are ready to go live, Crowdin sends the merge request with translations to your version control system. For every branch that is under localization, Crowdin creates an additional service branch with translations. We don’t commit directly to the master branch so that you can verify translations first.

Por padrão, l10n \ _ é adicionado ao nome da ramificação do serviço criado. If necessary, you can easily change it.

Configurações de sincronização

Por padrão, as fontes não são enviadas para o repositório com traduções. Although, if you perform a source text review in your Crowdin project and would like to push the changes made to your source files on Crowdin back to your repo, click Edit, select Push Sources in the integration settings, and click Save.

Há casos em que é necessário impedir que as traduções sejam enviadas temporariamente para o repo. In this situation, click Edit, clear Sync Schedule in the integration settings, and click Save. When ready to sync translations with the repo, select the Sync Schedule, and click Save.

A sincronização é processada a cada hora automaticamente. If necessary, you can change the update interval in the integration settings. Para configurar a programação de sincronização - clique emeditar, role para baixo até o agenda de sincronização, defina o intervalo preferido e clique em salvar.

Not depending on the synchronization settings, the source files’ changes on the repo will still be synced with Crowdin every ten minutes.

Ramos para sincronizar automaticamente

When you set up the integration, you select existing repository branches to be added to the Crowdin project. To add future branches from GitLab to Crowdin automatically, create a pattern for the branch names in the integration settings.

Por exemplo, você adiciona um recurso *padrão nas configurações de integração do GitLab. Nesse caso, as futuras ramificações que contenham essa palavra no final do título serão adicionados ao projeto.

Para adicionar um padrão para nomes de ramificações, siga estas etapas:

1. Clique em editar na seção de integração do GitLab.
2. In the appeared dialog, scroll down to the Branches to Sync Automatically.
3. No campo Ramos para sincronizar automaticamente, usar seletores de caractere curinga, como ‘*’, ‘?’, ‘[set]’, ‘' e outros para identificar os ramos necessários.
4. Clique em Salvar.

Default Configuration File Name

crowdin.yml é o nome do arquivo padrão usado para ramificações sincronizadas automaticamente. To change the default settings, click Edit, specify the preferred name in the Default configuration file name field in the integration settings, and click Save.

Selecionando conteúdo para sincronização

Para fazer a integração funcionar, você precisa especificar quais arquivos de origem devem ser traduzidos e como o Crowdin deve estruturar os arquivos traduzidos em seu repositório. If you see a red icon with an exclamatory mark next to the service branch name, it means that you didn’t select content for synchronization.

Há duas maneiras de fazer isso: configurando online ou manualmente, criando um arquivo de configuração.

Configurando online

Este procedimento é o mesmo para todas as integrações com sistemas de controle de versão (VCS). Verifica Integrações VCS: Configuração Online para saber como selecionar o conteúdo para sincronização online.

Criando arquivo de configuração

Configuration file crowdin.yml should be stored in the GitLab repository along with each separate branch that you want to translate, so Crowdin knows what files exactly should be sent for translations.

It should have the same structure as required for CLI, but your project’s credentials should not be stored in the file’s header for security reasons.

Leia mais sobre criando um arquivo de configuração.

Working with Multiple Repositories within One Project

When working with a multiplatform product that has versions for different operating systems, you might want to connect multiple repositories that contain source files for each operating system. In this case, localization resources (e.g., TMs, Glossaries) and translations could be used more efficiently, reducing the time needed for project localization.

To add another repository, follow these steps:

1. Open your project and go to the Applications tab.
2. Click on GitLab in the Applications list.
3. Click Add Repository.
4. Configure the integration with the new repository according to your needs and preferences.

Verificando o status da sincronização

Once the integration is set up, all the related information is stored in the Applications tab > GitLab section.

After the integration is connected, the settings can be updated only by the project member who configured it. All project managers except the person who configured the integration will see the Edit button disabled with the following notice when hovering over it: Integration was configured by {Full Name} ({username}).

A sincronização é processada a cada hora automaticamente. Se você precisar iniciar a sincronização instantaneamente – clique em Sincronizar agora.

Alternatively, if you need to sync only one branch separately, click on the needed branch and select Sync branch.

Carregue de traduções do Repo

By default, the translations stored on the repo are uploaded to Crowdin during the first synchronization only. Para carregar de traduções para o Crowdin manualmente, clique no botão suspenso no botão sincronizar agora, e clique em carregar traduções. The integration will upload existing translations to your Crowdin project.

Pergunta e resposta

Q: I have an application build configured to be triggered by every commit. Since Crowdin commits each translation file in a separate commit, how can I avoid unnecessary application builds triggered by commits from Crowdin? A: Since VCS integrations in Crowdin use API to commit files but not Git, each file is committed separately.

Here are a few recommendations that might help solve similar situations:

• Use the export_languages option to skip commits from languages you’re not interested in yet. Read more about the Export languages parameter for VCS integrations.
• Use the [ci skip] tag in the commit messages to skip unnecessary builds. Read more about the Commit Message parameter for VCS integrations.
• Configure the preferred sync interval using Sync Schedule (e.g., set the sync once in 24 hours).
• Squash commits when merging a localization branch to keep the master branch history clean and uncluttered.

Veja também

• Gerenciamento de versões