提示
有关 Phrase Strings 中 GitHub 集成的信息,请参阅 GitHub (Strings)。
GitHub 连接器允许直接从 GitHub 存储库下载源文件和上传目标文件。
该连接器使用 GitHub API 实现集成。该连接器允许访问与 GitHub 账户关联的所有存储库。GitHub 账户身份验证也可以在 GitHub 应用 中进行。
连接器有多种用例:
-
项目经理可以直接从线上存储库向项目添加文件。
-
设置 提交页面,允许提交者直接从线上存储库添加文件请求。
-
使用 自动项目创建 (APC),当检测到监控文件或文件夹中的 文件大小 发生更改时,自动创建新项目。
-
该连接器支持绝对路径设置。目标翻译文件只能存储在与源文件相同的分支中。
-
-
设置 持续作业,以监控选定文件的更改。
GitHub (Beta)
注释
该连接器自2026年6月起处于测试阶段。
身份验证
GitHub(测试版)连接器使用GitHub应用安装令牌而不是单个用户账户。令牌是短期有效的,并会自动续期。如果用户离开组织或失去存储库访问权限,连接器仍然可以正常工作。
GitHub(测试版)连接器仅支持GitHub应用身份验证。原始连接器的OAuth选项不受支持。
导出
GitHub(测试版)连接器将来自单个导出的所有文件批量处理为一个提交和一个拉取请求,因此无论文件数量如何,CI每次导出只运行一次。
当所有内容共享相同的存储库所有者、存储库和分支时,文件将被批量处理为一个提交。
如果APC配置为在每个文件单独完成时上传文件,则每个文件将单独提交,而不是批量处理。
提交消息是自动生成的,无法自定义。如果作为拉取请求导出,则可以自定义拉取请求名称和目标分支名称。
已知限制
-
该连接器只能列出、下载和上传文件。在GitHub中删除或移动文件不受支持。任何删除或重命名必须直接在GitHub中进行。
-
由于GitHub API的限制,文件列表可能无法正确工作,特别是对于超过50,000个文件的存储库。
-
目前不支持GitHub企业服务器。
-
新的连接器不支持旧连接器的OAuth流程。如果您的公司对GitHub应用程序的安装有限制,请在迁移之前解决这些问题。
迁移到新的GitHub(Beta)连接器
由于身份验证模型的更改,无法进行自动迁移。
前提条件:
-
对您的GitHub公司的管理员访问权限,以安装GitHub应用程序。在公司级别安装,以便覆盖所有APC监控的存储库。
-
现有的APC设置可见(在第二个选项卡中保持旧连接器打开)。
-
一个测试分支或非生产存储库,以便在切换实时工作流之前进行验证。
按照以下步骤操作:
-
安装Phrase GitHub应用程序。
-
在Phrase TMS中,从设置
页面,下拉到部分。
-
单击连接器。
页面打开。
-
单击新连接器。
页面打开。
-
将类型更改为GitHub(Beta)。
-
单击连接。
Phrase重定向到GitHub以授权Phrase GitHub应用程序。
-
在GitHub上,选择要授予访问权限的公司或账户及其存储库,然后确认安装。包括当前由现有连接器监控的所有存储库。
GitHub 会自动重定向到 Phrase。
-
选择要连接的用户或组织账户。
-
-
创建一个新的连接器。
-
在Phrase TMS中,从设置
页面,下拉到部分。
-
单击连接器。
-
单击新连接器。
-
选择在第一步中设置的 GitHub 应用安装。
-
从现有连接器复制设置:
-
存储库和分支
-
子文件夹路径(如果使用子文件夹监控)
-
文件筛选正则表达式(如果已配置)
-
导出模式:直接提交或拉取请求,以及目标分支
-
拉取请求名称和目标分支名称(如果使用 PR 模式)
可以在同一 GitHub 应用安装下创建多个连接器,每个连接器都有独立的设置。
-
-
-
使用干运行模式重新创建现有的 APC。
请勿删除或禁用现有的 APC。
-
创建指向新连接器的新 APC,镜像现有 APC 配置。
-
在激活每个新 APC 之前,启用 干运行 模式。干运行模式扫描存储库并匹配文件,而不会触发翻译作业。
-
查看匹配的文件。确认范围与现有 APC 监控的内容匹配。
-
-
通过测试导出进行验证。
-
对监控范围内的文件进行小的更改。
-
通过新的连接器触发导出。
-
确认:
-
创建一个单一的提交(而不是每个文件一个)。
-
提交显示在 GitHub 应用身份下,而不是个人账户下。
-
CI 运行一次,而不是每个文件一次。
-
-
-
切换实时工作流。
一旦验证通过:
-
禁用旧连接器上的 APC。
-
启用新连接器上的 APC(移除干运行模式)。
-
在停用旧连接器之前,监控一到两个导出周期。
-
-
停用旧连接器。
在确认新连接器稳定后:
-
删除旧的 APC。
-
从设置 → 连接器 → GitHub(旧版)中删除旧连接器。
-
可选地,撤销旧连接器使用的用户账户的 OAuth 令牌。
-
GitHub 设置(旧版)
不需要更改。
重要
如果从自定义域访问(例如mydomain.phrase.jp),请打开一个隐身浏览器窗口,并通过cloud.memsource.com或us.cloud.memsource.com登录,以应用创建或保存连接器所需的身份验证。保存后,可以通过自定义域访问连接器。
-
从设置
页面,下拉到部分。
-
单击连接器。
页面打开。
-
单击新连接器。
页面打开。
-
将类型更改为GitHub并为连接器提供一个名称。
-
可选选择并提供一个。
-
如有需要,选择以显示Phrase GitHub应用的URL,并使用GitHub应用授权流程导入/导出文件:
-
点击链接在新选项卡中打开Phrase App Connector官方页面:https://github.com/apps/phrase-app-connector-eu(欧盟数据中心)或https://github.com/apps/phrase-app-connector-us(美国数据中心)。
-
将Phrase GitHub应用安装到目标GitHub账户。
注释
如果GitHub应用未安装到用户的目标GitHub账户,则GitHub连接器仅能看到公共仓库。
-
通过选择任何将对GitHub连接器可见和可访问的私有仓库来完成安装程序。
-
返回Phrase 页面以授权GitHub应用并连接到GitHub。
-
-
点击连接到GitHub。如果未使用GitHub应用连接,将出现一个弹出窗口或新选项卡请求授权。
-
如有需要,请提供一个。
-
点击授权Phrase按钮。
如果使用GitHub应用,请点击授权Phrase App Connector按钮。
如果成功,窗口/选项卡将消失,并且在连接到GitHub按钮旁边会出现一个小勾号。
-
点击保存。
连接器已添加到页面的列表中。
重要
如果使用GitHub应用授权流程创建了GitHub连接器,则在保存连接器设置后无法更改授权方法。