GitHub 集成(基于字符串)

GitHub 集成可以让您将译文从 Crowdin 项目同步到您的 GitHub 仓库。

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

在基于字符串的项目中,GitHub 集成仅限于目标文件包模式运作。

目标文件包模式 – 根据您选择的格式,从 Crowdin 项目生成并推送到您的 GitHub 仓库的翻译文件。 在此模式下,集成会推送翻译文件,但不会同步仓库中的源。 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.

所有已完成的翻译都将被收集到包中,并自动作为合并请求推送到 GitHub 仓库中的 l10n 分支。

Note: An alternative to using this integration is the official Crowdin Github Action, which allows you to more flexibly configure workflows and fully control security and access to the repo, since you do not need to authorize a Github account in third-party services.

连接 GitHub 账户

  1. Open your project and go to the Integrations tab.
  2. 在集成列表中点击 GitHub
  3. 点击设置集成以通过您的 GitHub 账户进行集成。 GitHub 集成连接 GitHub
  4. 然后在 GitHub 端授权 Crowdin 的连接: GitHub 集成授权

如果所需的仓库是私有的,并且您对它的访问权限有限或没有,请请求仓库库所有者为您提供访问令牌。 Afterward, click Use personal access token and insert the token into the Token field and click Set Up Integration.

注意:设置包含访问令牌的集成时,请确保您对所需仓库具有管理员级别的权限。

选择仓库

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

GitHub 集成未配置

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

Read more about configuring target file bundles for VCS integration.

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

Read more about IP Addresses.

服务分支

When translations are finished and your languages are ready to go live, Crowdin sends the pull 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.

同步配置

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.

GitHub 同步设置

自动同步分支

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

For example, you add a pattern *feature in the GitHub 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. 在 GitHub 集成部分点击 编辑
  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.
    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.

Default Configuration File Name

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.

创建配置文件

配置文件 crowdin.yml 需要与您想要推送译文到的每个单独分支一起放置在 GitHub 仓库中,这样 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.

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. 在集成列表中点击 GitHub
  3. Click Add Repository.
  4. Configure the integration with the new repository according to your needs and preferences.

GitHub 集成多个仓库

检查同步状态

一旦集成设置完成,所有相关信息都将存储在集成选项卡 > GitHub 部分。

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.

GitHub 立即同步

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

GitHub 同步分支

Q&A

问:如果我的仓库成为 GitHub 组织的一部分,我该怎么办?
答:为了在 Crowdin 中继续使用 GitHub 集成,请遵循以下步骤:

  1. 在您的 GitHub 账户中转到 Authorized OAuth Apps
  2. 在列表中找到 Crowdin OAuth App 并撤销其访问权限。
  3. Set up the GitHub integration in your Crowdin 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:

本文是否有帮助?