GitHub 集成(基于字符串)

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

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

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

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

所有已完成的翻译都将被收集到包中,并自动作为合并请求推送到 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 账户进行集成。
  4. 然后在 GitHub 端授权与 Crowdin 企业版的连接。

如果所需的仓库是私有的,并且您对它的访问权限有限或没有,请请求仓库库所有者为您提供访问令牌。 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 integration in the Target File Bundles Mode will send the completed translations from your Crowdin Enterprise project without pulling sources from your repo. 因此,在选择应翻译的仓库和分支时,您可以指定集成应将生成的带有翻译的包放在何处。

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

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

详细了解 IP 地址

服务分支

当翻译完成并且您的语言准备好上线时,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 企业版项目的现有仓库分支。 要自动将未来的分支从 GitHub 添加到 Crowdin 企业版,请在集成设置中为分支名称创建模式。

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.

默认配置文件名称

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). 详细了解 配置 VCS 集成的目标文件包

创建配置文件

The configuration file crowdin.yml should be placed in the GitHub 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. 在集成列表中点击 GitHub
  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 > GitHub section.

After the integration is connected, the settings can be updated only by the project member who configured it. 除配置集成的人员外,所有项目管理员都将看到编辑按钮被禁用,并在将鼠标悬停在该按钮上时显示以下消息:集成由 {Full Name} 配置

By default, synchronization is processed every hour automatically. If you need to launch the synchronization immediately – click Sync Now. 或者,如果您只需要单独同步一个分支,请点击所需分支上的 并选择同步分支

GitHub Sync Now

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:

本文是否有帮助?