Integração do GitHub

A integração com o GitHub sincroniza arquivos de origem e tradução entre o repositório do GitHub e o projeto de tradução no Crowdin Enterprise. Todos os arquivos traduzidos e aprovados serão automaticamente pressionados como um pedido de extração para o ramo l10n no repositório GitHub.

Conectando o GitHub ao Crowdin Enterprise

Existem duas opções possíveis para você escolher. Você pode usar sua conta GitHub ou conta GitHub Enterprise.

Conectando à sua conta GitHub

1. Abra seu projeto no Crowdin Enterprise e vá para Aplicações > Sistema.
2. Clique em GitHub na lista de Integrações.
3. Clique em Configurar Integração para integrar por meio de sua conta GitHub.
4. Then authorize the connection with Crowdin Enterprise on the GitHub side.

Caso o repositório que você precisa é privado, e você tem acesso limitado ou nenhum, pergunte ao proprietário do repositório para lhe fornecer o Token de acesso. Depois, clique em Usar token de acesso pessoal e insira o token no campo Token e clique em Configurar Integração.

Conectando a conta corporativa do GitHub

1. Para integrar através da conta GitHub Enterprise, você deve criar um token de acesso. Certifique-se de selecionar os escopos necessários:

   • repo – Controle total de repositórios privados
   • admin:repo_hook – Controle total dos ganchos do repositório
2. Click on GitHub Enterprise in the Integrations 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 Enterprise IP addresses to the whitelist to ensure that it operates properly while staying secure.

Read more about IP Addresses.

Serviço de ramos

Quando as traduções terminarem e seus idiomas estiverem prontos, o Crowdin Enterprise enviará uma solicitação de mesclagem com traduções para o seu sistema de controle de versão. Para cada ramo que está em localização, o Crowdin Enterprise cria ramificação de serviço adicional com traduções. 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. No entanto, se você executar uma mudança de texto de origem no seu projeto Crowdin Enterprise e desejar enviar as alterações feitas nos arquivos de origem no Crowdin Enterprise de volta ao seu repositório, clique em editar, selecione Fontes de envio nas configurações da integração e clique em salvar.

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.

Não dependendo das configurações de sincronização, as alterações dos arquivos de origem no repositório ainda serão sincronizadas com o Crowdin Enterprise a cada dez minutos.

Ramos para sincronizar automaticamente

Quando você configura a integração, selecione as ramificações de repositório existentes para ser adicionado ao projeto do Crowdin Enterprise. To add future branches from GitHub to Crowdin Enterprise 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 GitHub. 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 Editar na seção de integração do GitHub.
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.

Nome do arquivo de configuração padrão

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 Enterprise 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 GitHub repository along with each separate branch that you want to translate, so Crowdin Enterprise 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. Abra seu projeto no Crowdin Enterprise e vá para Aplicações > Sistema.
2. Clique em GitHub na lista de Integrações.
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 > System > GitHub 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}.

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

Por padrão, as traduções armazenadas no repositório são enviadas para o Crowdin Enterprise durante a primeira sincronização apenas. Para fazer upload de traduções para o Crowdin Enterprise manualmente, clique em próximo no botão sincronizar agora, e clique em carregar traduções. A integração fará o carregamento das traduções existentes para o projeto no Crowdin Enterprise.

Pergunta e resposta

Q: What should I do if my repository becomes a part of the GitHub organization?
A: To continue using GitHub integration in Crowdin Enterprise, follow these steps:

1. Go to Authorized OAuth Apps in your GitHub account.
2. Find Crowdin OAuth App in the list and revoke its access.
3. Set up the GitHub integration in your Crowdin Enterprise project again using the instructions above.

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