集成
    1. Phrase
    2. Phrase Strings
    3. 集成

    GitHub (字符串)

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

    提示

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

    Phrase Strings 与 GitHub 存储库集成，以在 Phrase 和 GitHub 之间同步本地化文件。

    默认情况下，存储库通过 GitHub OAuth 应用程序连接。个人访问令牌也受支持，主要用于自托管实例或无法安装 OAuth 应用程序的环境。

    先决条件

    • .phrase.yml 配置 文件必须存在于要监控的分支的根目录中。该文件定义了从存储库导入 (pull) 或导出 (push) 哪些文件。

    • 存储库需要读取和写入权限。

    • 配置文件定义不正确可能会导致错误。确保文件至少包含一个 push 和一个 pull 目标、正确的文件格式以及正确的 update_translations 参数设置。

    • GitHub OAuth 应用:

      • GitHub OAuth 应用必须安装在拥有存储库的 GitHub 组织或账户中。

      • 存储库必须包含在 OAuth 应用的安装中。

      • 在目标组织或账户中需要安装或授权 GitHub 应用的权限。

    • GitHub 访问令牌:

      • 经典令牌

        需要 repo 范围（如果与公共存储库同步，则为 public_repo）

      • 细粒度令牌

        需要以下权限：

        • 内容：读取和写入

        • 拉取请求：读取和写入

      • 确保存储库设置不需要签名提交。

    • 如果在 GitHub 中启用了 SSO，也必须为访问令牌启用。

    • phrase_translations 分支不能被保护。

    注释

    由于持续改进，用户界面可能与视频中呈现的并不完全相同。

    连接存储库

    配置文件就位后，连接存储库，请按照以下步骤操作：

    1. 在 集成 页面，向下滚动到 存储库同步 并点击 配置。

      存储库同步 页面打开。

    2. 点击 添加同步/GitHub。

      GitHub 同步 设置窗口打开。

    3. 从下拉列表中选择一个项目。

    4. 选择身份验证方法：

      • GitHub 应用（推荐）

        如果 GitHub 应用尚未安装，请点击 身份验证。身份验证只需执行一次，可以用于多个存储库同步。

        如果 GitHub 应用已安装，请点击 管理安装 完成目标公司或账户的应用安装。存储库访问在组织或账户级别进行管理，并不与单个GitHub用户绑定。

      • 个人访问令牌

        提供一个带有API范围的个人存储库访问令牌。

        使用个人访问令牌时，存储库访问取决于创建该令牌的GitHub用户。

      • 自托管实例

        提供GitHub自托管API端点和一个带有API范围的个人存储库访问令牌。

    5. 从下拉列表中选择一个GitHub存储库。

    6. 从下拉列表中选择一个存储库分支以导入（推送）和导出（拉取）。这通常是主分支。

    7. 可选地，为拉取请求提供一个分支名称。如果留空，将创建一个默认值为短语翻译的分支。

    8. 点击验证配置以确保身份验证设置和配置文件正确。

    9. 可选地选择一个导入行为选项，以确定何时自动导入项目中的新文件或更新文件。

    10. 点击保存。

      该项目现在已连接到所选的GitHub存储库，并已添加到列表中。

    导入文件

    确保推送命令在.phrase.yml 配置文件中正确配置。推送选项与上传 API端点相同。

    要导入文件：

    • 从存储库同步页面，选择一个项目并点击导入 Sync Import.

      语言文件（在配置文件中定义为推送源条目）被导入到项目中。

      必须存在一个默认区域。

      注释

      如果在导入时出现问题，请使用CLI客户端在本地测试.phrase.yml配置文件，并检查任何错误消息。

      如有需要，联系Phrase技术支持并将.phrase.yml配置文件附加到支持请求中。

    导出文件

    确保拉取命令在.phrase.yml配置文件中正确配置。拉取选项（例如include_empty_translations参数）与本地下载 API端点相同。

    要导出文件：

    1. 从Repo Syncs页面，选择一个项目并点击导出Sync Export。

      将显示导出窗口。

    2. 在PR分支字段中提供目标分支。

      存储库中最新的文件将作为新的拉取请求导出到所需的分支。

    3. 一旦文件被导出，拉取请求可以在存储库中合并或关闭，并且可以删除该分支。

    注释

    如果在导出时出现问题，请使用CLI客户端在本地测试.phrase.yml配置文件，并检查任何错误消息。

    如有需要，联系Phrase技术支持并将.phrase.yml配置文件附加到支持请求中。

    历史记录

    Repo同步保留每个Phrase Strings项目的最新导入和导出的历史记录。

    要查看历史记录：

    • 从Repo Syncs页面，选择一个项目并点击历史记录Sync History。

      项目的导入和导出历史记录已呈现。历史中的导出条目包括指向相应合并请求的链接。

    这篇文章有帮助吗？
    ★ ★ ★ ★ ★

    Sorry about that! In what way was it not helpful?

    The article didn’t address my problem.
    I couldn’t understand the article.
    The feature doesn’t do what I need.
    Other reason.

    Note that feedback is provided anonymously so we aren't able to reply to questions.
    If you'd like to ask a question, submit a request to our Support team.
    Thank you for your feedback.