GitHub 集成(基于文件)

GitHub 集成允许您在 GitHub 仓库和 Crowdin 企业版项目之间同步文件。

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

有两种可能的 GitHub 集成模式可供选择:

  • 源文件和翻译文件模式 – 在 GitHub 仓库和 Crowdin 企业版项目之间同步源文件和翻译文件。
  • 目标文件包模式 – 以所选格式从 Crowdin 企业版项目生成翻译文件并将其推送到 GitHub 仓库。 在此模式下,集成会推送翻译文件,但不会同步仓库中的源。 如果您在 Crowdin 企业版项目中执行源文本审阅并希望将更新的源文本添加到您的仓库中,您可以将源语言添加为目标语言,该语言将与翻译一起推送到您的仓库中。

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

将 GitHub 与 Crowdin 企业版连接

有两种可能的选项, 您可以选择使用 GitHub 账户或 GitHub 企业版账户。

连接 GitHub 账户

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

如果您所需的仓库是私有的,并且您仅有有限的访问权限或没有访问权限,请让仓库所有者为您提供 访问令牌。 然后,点击 使用个人访问令牌 并将令牌填入 令牌 输入框中,然后点击 Set Up Integration

连接至 GitHub 企业版账户

  1. 要通过 GitHub 企业账户整合,您应该创建 访问令牌。 请确保选择所需范围:

    • repo – 对私有仓库完全控制权限
    • admin:repo_hook – 仓库钩子的完全控制
  2. 在集成列表中,点击 GitHub Enterprise
  3. 然后将您的访问令牌和根网址输入到相应的区域内。
  4. 点击设置集成,然后从下拉列表中选择源文件和翻译文件模式目标文件包模式以继续。

选择仓库

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.

详细了解重复字符串

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

详细了解为 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.

同步配置

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

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

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

By default, sources are not pushed to the repo with translations. 不过,如果您在 Crowdin 企业版项目中执行源文本审查,并希望将对 Crowdin 企业版上的源文件所做的更改推送回您的仓库,请单击编辑,在集成设置中选择推送源,然后点击保存

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 企业版同步。

要自动同步的分支

设置集成时,您可以选择要添加到 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. Click Edit in the GitHub 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. 点击 保存

默认配置文件名称

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.

选择要同步的内容

要使集成工作,您必须指定应翻译哪些源文件以及 Crowdin 企业版应如何在您的仓库中构建翻译后的文件。 如果您在服务分支名称旁看到带有感叹号的红色图标,则说明您尚未选择要同步的内容。

有两种方式:在线配置或通过创建配置文件手动配置。

在线配置

This procedure is the same for all integrations with version control systems (VCS). 查看VCS 集成:在线配置,了解如何在线选择同步内容。

创建配置文件

配置文件 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.

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

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

使用具有适用于不同操作系统的版本的多平台产品时,您可能需要连接包含每个操作系统的源文件的多个仓库。 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. 在集成列表中,点击 GitHub
  3. Click Add Repository.
  4. Configure the integration with the new repository according to your needs and preferences.

检查同步状态

设置集成后,所有相关信息都存储在集成 > GitHub部分。

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. 如果您需要立即启动同步 – 单击立即同步。 或者,如果您只需要单独同步一个分支,请单击所需分支上的 并选择 同步分支

立即同步 GitHub

从仓库中上传译文

默认情况下,存储在仓库中的翻译仅在第一次同步时上传到 Crowdin 企业版。 要手动将译文上传到 Crowdin 企业版,请点击 立即同步 按钮旁边的 ,然后点击 上传译文。 该集成会将现有翻译上传至您的 Crowdin 企业版项目。

疑问解答

问题:如果我的仓库成为 GitHub 组织的一部分,我该怎么办?
解答:要继续在 Crowdin 企业版中使用 GitHub 集成,请按照以下步骤操作:

  1. 在您的 GitHub 账户中转到 Authorized OAuth Apps
  2. 在列表中找到 Crowdin OAuth 应用程序并撤销其访问权限。
  3. 使用上文所述的指引再次在您的 Crowdin 企业项目中设置 GitHub 集成。

Q: I have an application build configured to be triggered by every commit. 由于 Crowdin 在单独的提交中提交每个翻译文件,我如何避免由 Crowdin 的提交触发不必要的应用构建?
答:由于 Crowdin 中的 VCS 集成使用 API 来提交文件而不是 Git,因此每个文件都是单独提交的。

Here are a few recommendations that might help solve similar situations:

  • Use the export_languages option to skip commits from languages you’re not interested in yet. 详细了解 VCS 集成的导出语言参数
  • Use the [ci skip] tag in the commit messages to skip unnecessary builds. 详细了解 VCS 集成的提交消息参数
  • Configure the preferred sync interval using Sync Schedule (e.g., set the sync once in 24 hours).
  • Squash commits when merging a localization branch to keep the master branch history clean and uncluttered.

另请参阅

本文是否有帮助?