Интеграция с GitLab

Integration with GitLab synchronizes source and translation files between your GitLab repository and translation project in Crowdin. All translated and approved files will be automatically pushed as a merge request to the l10n branch in the GitLab repository.

Соединение GitLab с Crowdin

There are two possible options you can choose from. You can either use your GitLab account or GitLab Enterprise account.

Connecting GitLab Account

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

Connecting GitLab Enterprise Account

  1. To integrate via GitLab Enterprise account you should create an access token. Make sure to select the required scope:

    • api – Grants complete read/write access to the API, including all groups and projects, the container registry, and the package registry

      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 Integrations list.
  3. Then insert your access token and Base URL into corresponding fields. Click Set Up Integration to proceed. GitLab Integration Connecting GitLab Enterprise

Selecting Repository

In the appeared dialog, select your repository and branches that should be translated. It’s recommended to switch Duplicate Strings to Show (Recommended for versions), so identical strings will be hidden between branches.

Read more about Duplicate Strings.

Gitlab Integration Unconfigured

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

Read more about IP Addresses.

Служебные ветви

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.

By default, l10n_ is added to the created service branch name. If necessary, you can easily change it.

Synchronization Settings

By default, sources are not pushed to the repo with translations. 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.

There are cases when it’s necessary to disable translations from being pushed to the repo temporarily. In this situation, click Edit, clear Push Translations in the integration settings, and click Save. When ready to sync translations with the repo, select the Push Translations, and click Save.

The synchronization is processed every hour automatically. If necessary, you can change the update interval in the integration settings. To configure the synchronization schedule – click Edit, scroll down to the Sync Schedule, set the preferred interval, and click Save.

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

GitLab Sync Settings

Branches to Sync Automatically

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.

For example, you add a pattern *feature in the GitLab integration settings. In this case, the future branches that contain this word at the end of the title will be added to the project.

To add a pattern for branch names, follow these steps:

  1. Click Edit in the GitLab integration section.
  2. In the appeared dialog, scroll down to the Branches to Sync Automatically.
  3. In the Branches to Sync Automatically field, use wildcard selectors such as ‘*’, ‘?’, ‘[set]’, ‘' and others to identify the necessary branches.
  4. Нажмите по кнопке Сохранить. Branches to Sync Automatically

Default Configuration File Name

crowdin.yml is the default file name that is used for automatically synchronized branches. 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.

Default Configuration File Name

Выбор контента для синхронизации

Чтобы обеспечить интеграцию, вы должны указать, какие исходные файлы должны быть переведены и как Crowdin должен структурировать переведенные файлы в вашем репозитории. 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.

There are two ways to do that: configuring online or manually by creating a configuration file.

Настройка Онлайн

Эта процедура одинакова для интеграций со всеми системами контроля версий (VCS). Check VCS Integrations: Configuring Online to get to know how to select content for synchronization online.

Создание файла конфигурации

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.

Подробнее о создании файла конфигурации.

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 Crowdin project and go to Settings > Integrations tab.
  2. Click on GitLab in the Integrations list.
  3. Click Add Repository.
  4. Configure the integration with the new repository according to your needs and preferences.

GitLab Integration Multiple Repositories

Проверка состояния синхронизации

Once the integration is set up, all the related information is stored in the same place – Settings > Integrations tab > GitLab section. The synchronization is processed every hour automatically. If you need to launch the synchronization instantly – click Sync Now.

GitLab Sync Now

Uploading Translations from Repo

By default, the translations stored on the repo are uploaded to Crowdin during the first synchronization only. To upload translations to Crowdin manually, click on the drop-down toggle on the Sync Now button, and click Upload Translations. The integration will upload existing translations to your Crowdin project.

GitLab Upload Translations

Полезная информация

Была ли эта статья полезной?