GitLab 集成(基于字符串)

The GitLab integration allows you to synchronize translations from your Crowdin Enterprise project to GitLab repo.

Note: You will need to install the GitLab integration in your Crowdin account before you can set it up and use it.

In string-based projects, GitLab integration exclusively operates in the Target file bundles mode.

Target file bundles mode – generate and push translation files to your GitLab repository from the Crowdin Enterprise project in the selected format. 在此模式下,集成会推送翻译文件,但不会同步仓库中的源。 如果您在 Crowdin 企业版项目中执行源文本审阅并希望将更新的源文本添加到您的仓库中,您可以将源语言添加为目标语言,该语言将与翻译一起推送到您的仓库中。

All completed translations are collected into bundles and automatically pushed as a merge request to the l10n branch in the GitLab repository.

连接 GitLab 账户

  1. Open your project and go to the Integrations tab.
  2. Click on GitLab in the Integrations list.
  3. Click Set Up Integration to integrate via your GitLab account.
  4. 然后在 GitLab 端授权与 Crowdin 企业版的连接。

In case the repository you need is private, and you have limited or no access to it, please ask the repository owner to provide you with an access token. Afterward, click Use personal access token and insert the token into the Token field and click Set Up Integration.

Note: When setting up an integration with an access token, ensure that you have the Maintainer level permission to the necessary repo.

选择仓库

In the appeared dialog, select your repository and branches that should be translated.

GitLab integration in the Target File Bundles Mode will send the completed translations from your Crowdin Enterprise project without pulling sources from your repo. 因此,在选择应翻译的仓库和分支时,您可以指定集成应将生成的带有翻译的包放在何处。

Read more about configuring target file bundles for VCS integration.

当您使用私有集成(例如,与自托管 VCS 集成)时,您需要将专用的 Crowdin 企业版 IP 地址添加到白名单中,以确保其正常运行并保持安全。

Read more about IP Addresses.

服务分支

当翻译完成并且您的语言准备好上线时,Crowdin 企业版会将合并请求和翻译发送到您的版本控制系统。 对于每个进行本地化的分支,Crowdin 企业版都会创建一个带有翻译的附加服务分支。 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.

同步配置

There are cases when it’s necessary to disable translations from being pushed to the repo temporarily. 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.

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.

自动同步分支

设置集成时,您可以选择要添加到 Crowdin 企业版项目的现有仓库分支。 要自动将未来的分支从 GitLab 添加到 Crowdin 企业版,请在集成设置中为分支名称创建模式。

例如,您在 GitLab 集成设置中添加**功能*模式。 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. Click Save.

默认配置文件名称

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.

If you don’t specify your custom configuration file name for automatically synchronized branches, and the integration doesn’t find a configuration file with the default name crowdin.yml in the root of the branch, these branches will be marked in the integration settings with a red icon with an exclamation mark saying “Not Ready. Check the configuration”.

选择要同步的内容

To make integration work in the Target file bundles mode, you need to select the required bundles that you want to push to your repository. If you see a red icon with an exclamation mark next to the service branch name, it means that you haven’t selected any content for synchronization.

There are two ways you can specify content for synchronization:

  • Configuring online
  • Configuring manually by creating a configuration file

在线配置

This procedure is the same for all integrations with version control systems (VCS). Read more about configuring target file bundles for VCS integration.

创建配置文件

The configuration file crowdin.yml should be placed in the GitLab repository along with each separate branch you want to push translations to, so that Crowdin Enterprise knows exactly which translation bundles to send to your repository.

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.

Read more about creating a configuration file.

Working with Multiple Repositories within One Project

If you’re working with a multi-platform product that has versions for different operating systems, you may want to connect multiple repositories that store content 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 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.

检查同步状态

Once the integration is set up, all related information is stored in the Integrations > 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 message when hovering over it: Integration was configured by {Full Name}.

By default, synchronization is processed every hour automatically. If you need to launch the synchronization immediately – click Sync Now. Alternatively, if you need to sync only one branch separately, click on the needed branch and select Sync branch.

GitLab Sync Now

Q&A

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:

本文是否有帮助?