GitHub (TMS)

文本由 Phrase Language AI 从英语机器翻译而得。

适用于

团队、商业和企业版计划

有关许可问题，请联系销售部门。

适用于

旗舰版和企业版计划（旧版）

有关许可问题，请联系销售部门。

提示

有关 Phrase Strings 中 GitHub 集成的详细信息，请参阅 GitHub (Strings)。

GitHub 连接器允许直接从 GitHub 存储库下载源文件，并将目标文件上传至该存储库。

该连接器使用 GitHub API 来实现集成。该连接器允许访问与 GitHub 帐户关联的所有存储库。GitHub 帐户身份验证也可以在 GitHub App 中完成。

使用案例

该连接器有多种使用案例：

项目经理可以直接从在线存储库将文件添加到项目中。
设置提交者门户，以允许提交者直接从在线存储库将文件添加到请求中。
使用自动项目创建 (APC)，以便在受监控的文件或文件夹中检测到 文件大小 变化时自动创建新项目。
- 此连接器支持绝对路径设置。目标翻译文件只能存储在与源文件相同的分支中。
设置持续作业以监控所选文件的更改。

GitHub (Beta)

注意

截至 2026 年 6 月，该连接器处于 Beta 测试状态。

身份验证

GitHub (Beta) 连接器使用 GitHub App 安装令牌 而不是个人用户帐户。令牌有效期较短，并会自动续订。如果用户离开组织或失去仓库访问权限，连接器仍可继续工作。

GitHub (Beta) 连接器仅支持 GitHub App 身份验证。不支持原始连接器中的 OAuth 选项。

导出

GitHub (Beta) 连接器将单次导出中的所有文件合并为一个提交和一个拉取请求，因此无论文件数量多少，CI 每次导出仅运行一次。

当所有内容共享相同的仓库所有者、仓库和分支时，文件会被合并为一个提交。

如果 APC 配置为在文件单独完成时上传，则每个文件将单独提交，而不是合并提交。

提交信息是自动生成的，无法自定义。如果以拉取请求方式导出，则可以自定义拉取请求名称和目标分支名称。

已知限制

该连接器仅支持列出、下载和上传文件。不支持在 GitHub 中删除或移动文件。任何删除或重命名操作必须直接在 GitHub 中完成。
由于 GitHub API 的限制，文件列表功能可能无法在拥有超过 50,000 个文件的仓库中正常工作。
目前不支持 GitHub Enterprise Server。
新连接器不支持来自旧版连接器的 OAuth 流程。如果您的组织对 GitHub App 安装有限制，请在迁移前解决这些限制。

切换到新的 GitHub (Beta) 连接器

由于身份验证模型发生变化，无法进行自动迁移。

注意

将连续 APC从旧版连接器切换到新连接器不属于迁移。Phrase 将其视为新的连接器配置，因此 APC 会将源文件重新导入为新作业，而不是更新现有作业。该文件被视为新内容，因此之前处理过的字数和机器翻译单元 (MTU) 不会结转。在项目进行中切换连接器时，受影响文件的字数统计和 MTU 消耗将反映为完全重新导入。

先决条件：

拥有 GitHub 组织管理员权限以安装 GitHub App。在组织级别进行安装，以便覆盖 APC 监控的所有存储库。
GitHub App 安装必须有权访问包含待翻译内容的存储库，否则通过 APC 的导入将会失败。
可见现有的 APC 设置（在第二个标签页中保持旧连接器打开）。
在切换实时工作流之前，使用测试分支或非生产存储库进行验证。

请按照以下步骤操作：

安装 Phrase GitHub App。
1. 在 Phrase TMS 中，从“设置”页面向下滚动到“集成”Integrations部分。
2. 点击连接器。
  
  连接器页面随即打开。
3. 点击新建连接器。
  
  创建连接器页面随即打开。
4. 将类型更改为GitHub (Beta)。
5. 点击连接。
  
  Phrase 会重定向到 GitHub 以授权 Phrase GitHub App。
6. 在GitHub上，选择要授予访问权限的组织或账户以及存储库，然后确认安装。包含当前由现有连接器监控的每个存储库。
  
  GitHub 会自动重定向回 Phrase。
7. 选择要连接的用户或组织账户。
创建一个新连接器。
1. 在 Phrase TMS 中，从“设置”页面向下滚动到“集成”Integrations部分。
2. 点击连接器。
3. 点击新建连接器。
4. 选择第一步中设置的 GitHub App 安装。
5. 从现有连接器复制设置：
  - 存储库和分支
  - 子文件夹路径（如果使用子文件夹监控）
  - 文件过滤器正则表达式（如果已配置）
  - 导出模式：直接提交或拉取请求，以及目标分支
  - 拉取请求名称和目标分支名称（如果使用PR模式）
  可以在同一个GitHub App安装下创建多个连接器，每个连接器都有独立的设置。
使用试运行模式重新创建现有的APC。

请勿删除或禁用现有的 APC。
1. 创建指向新连接器的新 APC，并镜像现有的 APC 配置。
2. 在激活每个新 APC 之前，请启用试运行模式。试运行模式会扫描存储库并匹配文件，而不会触发翻译作业。
3. 检查匹配的文件。确认范围与现有 APC 监控的范围相符。
通过测试导出进行验证。
1. 对监控范围内的文件进行小幅修改。
2. 通过新连接器触发导出。
3. 确认：
  - 创建了单个提交（而非每个文件一个提交）。
  - 提交显示在 GitHub App 身份下，而非个人账户下。
  - CI 运行一次，而非每个文件运行一次。
切换实时工作流。

验证通过后：
1. 禁用旧连接器上的 APC。
2. 启用新连接器上的 APC（移除试运行模式）。
3. 在停用旧连接器之前，监控一到两个导出周期。
停用旧连接器。

确认新连接器稳定后：
1. 删除旧的 APC。
2. 从“设置”→“连接器”→“GitHub (旧版)”中删除旧版连接器。
3. （可选）撤销旧版连接器所使用的用户账户的 OAuth 令牌。

GitHub 设置（旧版）

无需进行任何更改。

Phrase TMS 设置

重要提示

如果通过自定义域（例如 mydomain.phrase.jp）访问，请打开一个无痕浏览器窗口，并通过 cloud.memsource.com 或 us.cloud.memsource.com 登录，以应用创建或保存连接器所需的身份验证。保存后，即可通过自定义域访问该连接器。

在“设置”页面中，向下滚动至“集成”Integrations部分。
点击连接器。

连接器页面随即打开。
点击新建连接器。

创建连接器页面随即打开。
将类型更改为GitHub，并为连接器指定名称。
（可选）启用Use custom domain并提供API URL。
（可选）选择Export translations as pull requests并提供Pull request branch。
如果需要，选择Use Github app以显示 Phrase GitHub 应用 URL，并使用 GitHub 应用授权流程导入/导出文件：
1. 点击链接，在新标签页中打开 Phrase App Connector 官方页面：https://github.com/apps/phrase-app-connector-eu（欧盟数据中心）或https://github.com/apps/phrase-app-connector-us（美国数据中心）。
2. 将 Phrase GitHub 应用安装到目标 GitHub 账户。
  
  注意
  
  如果未将 GitHub 应用安装到用户的目标 GitHub 账户，GitHub 连接器将仅能看到公共存储库。
3. 为完成安装过程，请选择 GitHub 连接器可见且可访问的任何私有存储库。
4. 返回 Phrase Connectors/Create 页面以授权 GitHub 应用并连接到 GitHub。
点击 Connect to GitHub。如果未使用 GitHub App 进行连接，系统将弹出窗口或打开新标签页，要求进行授权。
如果需要，请提供 Commit message。
点击 Authorize Phrase 按钮。

如果使用 GitHub App，请点击 Authorize Phrase App Connector 按钮。

如果成功，窗口/标签页将关闭，并且 Connect to GitHub 按钮旁边会出现一个小勾号。
点击 Save。

该连接器已添加到 Connectors 页面上的列表中。

重要提示

如果 GitHub 连接器是使用 GitHub App 授权流程创建的，则在保存连接器设置后，无法更改授权方式。

删除连接器

要删除连接器：

在 Integrations 页面中，选择要删除的连接器。
点击 Delete。

Delete connector 窗口随即打开。
输入“delete”并点击 Delete。

连接器已删除，并显示连接器列表。

注意

如果连接器仍与项目中的未完成作业（包括回收站中的作业）相关联，则无法将其删除。尝试删除此类连接器会返回“Failed to delete connector”错误。

解决方法：打开与该连接器关联的项目，并完成或删除所有剩余作业。前往 Settings/Recycle bin，并清空回收站，以移除仍与该连接器关联的任何作业。重试删除连接器。