GitLab 集成(基于文件)

GitLab 集成允许您在 GitLab 仓库和 Crowdin 项目之间同步文件。

注意:您需要在 Crowdin 账户中安装 GitLab 集成,然后才能进行设置和使用。

在基于文件的项目中,您可以选择两种可能的 GitLab 集成模式:

  • 源文件和翻译文件模式 – 在 GitLab 仓库和 Crowdin 项目之间同步源文件和翻译文件。
  • 目标文件包模式 – 以所选格式从 Crowdin 项目生成翻译文件并将其推送到您的 GitLab 仓库。 在此模式下,集成会推送翻译文件,但不会同步仓库中的源。 In cases when you perform a source text review in your Crowdin project and want to get updated source texts to your repo, you can add a source language as a target language, which will be pushed to your repo along with translations.

在上述任一模式下,所有已翻译和批准的文件都将作为合并请求自动推送到 GitLab 仓库中的 l10n 分支。

连接 GitLab 账户

  1. 打开您的项目并转到集成选项卡。
  2. 点击集成列表中的 GitLab
  3. 点击设置集成,然后从下拉列表中选择源文件和翻译文件模式目标文件包模式,以通过您的 GitLab 账户进行集成。 GitLab 集成连接 GitLab
  4. 然后在 GitLab 端授权与 Crowdin 的连接: GitLab Integration Authorization

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. 然后,点击 使用个人访问令牌 并将令牌填入 令牌 输入框中,然后点击 Set Up Integration

注意:当设置一个与访问令牌的集成时,请确保您在仓库中拥有必要的维护层权限。

选择仓库

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. In other cases, feel free to use a regular one.

Read more about Duplicate Strings.

GitLab 集成未配置

目标文件包模式 中使用 GitLab 集成时,集成将从您的 Crowdin 项目发送完成的译文,而无需从您的仓库中提取源文件。 因此,在选择应翻译的仓库和分支时,您可以指定集成应将生成的带有翻译的包放在何处。

详细了解配置 VCS 集成的目标文件包

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

阅读更多有关 IP 地址 的信息。

服务分支

当翻译完成并且您的语言准备好上线时,Crowdin 会将附有译文的合并请求发送到您的版本控制系统。 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.

同步配置

要从仓库导入现有翻译,请选择以下选项之一:

  • 分支连接后一次性导入翻译
  • 始终从仓库导入新翻译

默认情况下,选择第一个选项仅导入翻译一次。 或者,如果您不想从仓库导入翻译,则可以清除这两个选项。

GitLab 译文导入选项

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 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.

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

GitLab 同步设置

自动同步分支

When you set up the integration, you select existing repository branches to be added to the Crowdin project. 要将未来的分支从 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. 点击 GitLab 集成部分中的编辑
  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

默认配置文件名称

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, you need to specify which source files should be translated and how Crowdin should structure translated files in 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). Check VCS Integrations: Configuring Online to get to know how to select content for synchronization online.

创建配置文件

配置文件 crowdin.yml 应与要翻译的每个独立分支一起保存在 GitLab 仓库中,这样 Crowdin 就能知道哪些文件需要翻译。

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.

阅读更多关于 创建配置文件 的信息。

在一个项目内使用多个存储库

If you’re working with a multi-platform product that has versions for different operating systems, you may 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. 打开您的项目并转到集成选项卡。
  2. 点击集成列表中的 GitLab
  3. Click Add Repository.
  4. Configure the integration with the new repository according to your needs and preferences.

GitLab 集成多个仓库

检查同步状态

集成设置完成后,所有相关信息都将存储在 集成标签页 > GitLab 部分中。

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} ({username}).

By default, synchronization is processed every hour automatically. If you need to launch the synchronization immediately – click Sync Now.

立即同步 GitLab

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

GitLab 同步分支

从仓库中上传译文

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 上传译文

疑问解答

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:

另请参阅

本文是否有帮助?