GitHub

GitHub 集成 {#github}

Git 仓库是绝大多数软件项目的核心。我们与 GitHub 集成，以便在你的拉取请求中直接提供 Tuist 洞察，并为你节省一些配置工作，例如同步默认分支。

你需要在组织的「集成」选项卡中安装 Tuist GitHub 应用： An image that shows the integrations tab

之后，你可以在 GitHub 仓库和 Tuist 项目之间添加项目连接：

An image that shows adding the project connection

::: tip IP 白名单

如果你的 GitHub 组织使用了 IP 白名单或者你的 GitHub 实例在防火墙后面，请确保将 Tuist 的出站 IP 地址添加到白名单，以便集成可以与你的仓库通信。

:::

GitHub 应用会发布 Tuist 运行报告，其中包括 PR 摘要，以及指向最新预览或测试的链接：

An image that shows the pull request comment

::: info 要求

只有当你的 CI 运行通过认证时，才会发布评论。

:::

::: info GITHUB_REF

如果你有一个自定义工作流，它不是由 PR 提交触发的，而是例如由 GitHub 评论触发的，你可能需要确保 GITHUB_REF 变量设置为 refs/pull/<PR_NUMBER>/merge 或 refs/pull/<PR_NUMBER>/head。

你可以使用带前缀的 GITHUB_REF 环境变量运行相关命令，如 tuist share：GITHUB_REF=“refs/pull/${{ github.event.issue.number }}/head” tuist share

:::