提示
有关 GitHub 在 Phrase TMS 中集成的信息,请参阅 GitHub (TMS)。
Phrase Strings 与 GitHub 存储库集成,以在 Phrase 和 GitHub 之间同步本地化文件。
默认情况下,存储库通过 GitHub OAuth 应用程序连接。个人访问令牌也受支持,主要用于自托管实例或无法安装 OAuth 应用程序的环境。
先决条件
-
.phrase.yml配置 文件必须存在于要监视的分支的根目录中。该文件定义了从存储库导入(pull)或导出(push)哪些文件。 -
存储库需要读取和写入权限。
-
配置文件定义不正确可能会导致错误。确保文件至少包含一个 push 和一个 pull 目标、正确的文件格式以及正确的
update_translations参数设置。 -
-
GitHub OAuth 应用必须安装在拥有存储库的 GitHub 组织或账户中。
-
存储库必须包含在 OAuth 应用安装中。
-
在目标组织或账户中需要安装或授权 GitHub 应用的权限。
-
-
-
经典令牌
需要 repo 范围(如果与公共存储库同步,则为
public_repo) -
细粒度令牌
需要以下权限:
-
内容:读取和写入
-
拉取请求:读取和写入
-
-
确保存储库设置不需要签名提交。
-
-
如果在 GitHub 中启用了 SSO,也必须为访问令牌启用。
-
phrase_translations 分支不能被保护。
确保推送命令在.phrase.yml 配置文件中正确配置。推送选项与上传 API端点相同。
要导入文件:
-
在 页面,选择一个项目并点击 导入
。
语言文件(在配置文件中定义为推送源条目)被导入到项目中。
必须存在一个默认区域。
注释
如果在导入时出现问题,请使用 CLI 客户端在本地测试
.phrase.yml配置文件,并检查任何错误信息。如有需要,联系 Phrase 技术支持 并将
.phrase.yml配置文件附加到支持请求中。
确保拉取命令在 .phrase.yml 配置 文件中正确配置。拉取选项(例如 include_empty_translations 参数)与 locales download API 端点相同。
要导出文件:
-
在 页面,选择一个项目并点击 导出
。
将显示 窗口。
-
在 字段中提供目标分支。
存储库中最新的文件将作为新的拉取请求导出到所需的分支。
-
一旦文件被导出,拉取请求可以在存储库中合并或关闭,并且可以删除该分支。
注释
如果在导出时出现问题,请使用 CLI 客户端在本地测试 .phrase.yml 配置文件,并检查任何错误信息。
如有需要,联系 Phrase 技术支持 并将 .phrase.yml 配置文件附加到支持请求中。