跳转到内容
搜索文档

GitHub 集成

最后更新 查看 MarkdownAgent 设置

Cloudflare 支持将 GitHub 仓库连接到 Cloudflare Worker,并在每次推送更改时自动部署代码。

功能

除了自动构建和部署外,Cloudflare GitHub 集成还允许你直接在 GitHub 中监控构建,无需离开工作流即可了解状态。

拉取请求评论

如果提交位于拉取请求中,Cloudflare 会自动在拉取请求上发布包含构建状态的评论。

GitHub 拉取请求评论

对于执行 wrangler versions upload 的构建,将提供预览 URL。这在审查拉取请求时特别有用,因为它允许你将代码更改与更新后的 Worker 版本一起比较。

评论历史会显示 PR 打开期间完成的任何早期构建。

GitHub 拉取请求评论历史

检查运行

如果你有一个或多个 Worker 连接到仓库(即 monorepo),可以通过 GitHub 检查运行在 GitHub 中查看每个构建的状态。

你可以在 GitHub 仓库中选择提交旁的状态图标来查看检查。在下面的示例中,可以选择绿色勾选标记查看检查运行的结果。

GitHub 状态

检查运行在你的仓库中会显示如下。你可以选择 Details(详情) 查看与每个检查关联的构建(Build ID)和项目(Script)。

GitHub 检查运行

请注意,使用构建监视路径时,只有触发构建的项目才会生成检查运行。

管理访问权限

你可以使用 Cloudflare Workers & Pages GitHub App 从 GitHub 上的公司或副业项目部署到 Cloudflare Worker。

组织访问

授权 Cloudflare Worker 访问 GitHub 账户时,可以指定访问你的个人账户或你在 GitHub 上所属的组织。

要向组织添加 Cloudflare Worker 安装,你的用户账户必须是所有者或在组织内拥有适当角色(即 GitHub Apps Manager 角色)。有关这些角色的更多信息,请参阅 GitHub 文档

移除访问权限

你可以前往 GitHub 上的 Applications(应用)页面(如果你在组织中,选择 Switch settings context(切换设置上下文) 以访问 GitHub 组织设置)移除 Cloudflare Worker 对 GitHub 仓库或账户的访问。GitHub App 名为 Cloudflare Workers and Pages,Worker 和 Pages 项目共用。

移除 Cloudflare 对 GitHub 仓库的访问

要移除对单个 GitHub 仓库的访问,可以导航到 Repository access(仓库访问)。选择 Only select repositories(仅选择仓库) 选项,并配置你希望 Cloudflare 有权访问的仓库。

GitHub 仓库访问

移除 Cloudflare 对整个 GitHub 账户的访问

要移除 Cloudflare Worker 和 Pages 对整个 Git 账户的访问,可以导航到 Uninstall "Cloudflare Workers and Pages",然后选择 Uninstall(卸载)。移除对 Cloudflare Workers and Pages 应用的访问将撤销 Cloudflare 对该 GitHub 账户_所有仓库_的访问。如果你只想禁用自动构建和部署,请按照断开构建连接说明操作。

请注意,移除对 GitHub 的访问将禁用连接到这些仓库的 Worker 和 Pages 项目的新构建,但你之前的部署仍由 Cloudflare Worker 托管。

重新安装 Cloudflare GitHub App

遇到 Git 集成相关问题时,一种潜在的排查步骤是尝试卸载并重新安装与 Cloudflare Pages 安装关联的 GitHub 或 GitLab 应用程序。下面提供了每个 Git 提供商的流程。

  1. 前往 GitHub 上的安装设置页面:
    • 导航到 Worker 或 Pages 项目的 Settings(设置) > Builds(构建),并在 Git Repository 下选择 Manage(管理)
    • 或者,访问以下链接找到 Cloudflare Workers and Pages 安装并选择 Configure(配置)
Individual https://github.com/settings/installations
Organization https://github.com/organizations/<YOUR_ORGANIZATION_NAME>/settings/installations
  1. 在 Cloudflare Workers and Pages GitHub App 设置页面,导航到 Uninstall "Cloudflare Workers and Pages" 并选择 Uninstall(卸载)
  2. 返回 Workers & Pages 概览页面。选择 Create application(创建应用程序) > Pages > Connect to Git(连接到 Git)
  3. 选择 + Add account(+ 添加账户) 按钮,选择要添加的 GitHub 账户,然后选择 Install & Authorize(安装并授权)
  4. 你应该会被重定向到创建项目页面,账户列表中显示你的 GitHub 账户或组织。
  5. 尝试为之前出问题的项目进行新部署。

这篇文档对您有帮助吗?