Skip to main content
Cypress云服务免费试用

GitLab

info
你将学到​
  • 如何安装 Cypress GitLab 集成
  • 如何配置状态检查和合并请求评论

Cypress Cloud 可以通过状态检查和合并请求评论将你的 Cypress 测试与 GitLab 工作流集成。项目首先需要设置为记录到 Cypress Cloud 才能使用 GitLab 集成。

GitLab 合并请求评论展示运行属性、测试结果和待审查测试
caution

启用集成的用户需要拥有 GitLab 的管理员权限。

caution

GitLab 集成依赖于你的 CI 环境可靠地提供提交 SHA（通常通过环境变量）。这对大多数用户来说不是问题，但如果你在使用 CI 设置时遇到 GitLab 集成问题，请确保按照这些指南正确发送 git 信息。如果在此之后仍然遇到问题，请联系我们。

企业版 GitLab（自托管）​

tip

Cypress Cloud 高级功能

企业版 GitLab（自托管）包含在我们的商业和企业付费定价计划中。

企业版 GitLab（自托管）集成依赖于你的 GitLab 实例能够通过开放互联网访问我们的 Cypress Cloud API。如果你的实例运行在防火墙后面，可能需要重新配置安全基础设施以允许与我们的服务器通信。

安装 GitLab 集成​

caution

GitLab OAuth2 应用程序将允许 Cypress Cloud 以注册用户的身份进行认证。这意味着 Cypress 将能够看到注册用户可以访问的每个 GitLab 仓库。如果你想更严格地控制 Cypress 可见的仓库，可以考虑在 GitLab 中创建一个具有更有限访问权限的服务账户。

  1. 访问 Cypress Cloud 的组织页面或打开组织切换器。

  2. 选择你希望与 GitLab 集成的组织。

    选择一个组织

  3. 通过侧边导航访问所选组织的集成页面。

    从集成中安装 Cypress GitLab

  4. 点击 GitLab 或 **企业版 GitLab（自托管）**下的启用按钮。

  5. 按照说明在 GitLab 中创建一个新的 OAuth2 应用程序。详情请参阅 GitLab 文档。

  6. 将应用程序 ID 和密钥复制回 Cypress Cloud。

  7. （仅限自托管 GitLab）将你的 GitLab 实例的基础 URL 复制到 Cypress Cloud 的 GitLab URL 字段。

  8. 在项目设置 → GitLab 集成或企业版 GitLab 集成中将项目连接到 GitLab 仓库。

  9. （可选）为每个项目配置行为。

warning

如果你在限制性 VPN 内运行测试，请参阅需要将哪些子域名添加到允许列表以使 Cypress Cloud 和 GitLab 集成正常工作

配置 GitLab 集成​

状态检查​

默认情况下，Cypress 会发布一个 cypress/run 提交状态，包含 Cypress 运行的结果。这将阻止你的团队合并任何带有失败 Cypress 测试的 MR。

此外，Cypress 可以发布一个 cypress/flake 提交状态，指示 Cypress 运行是否包含任何不稳定的测试。这将阻止你的团队合并任何带有不稳定测试的 MR。

你可以在项目的项目设置页面管理此行为。

项目设置页面切换状态检查以切换报告运行状态或报告不稳定测试
tip

Cypress Cloud 高级功能

报告不稳定状态检查包含在我们的团队、商业和企业付费定价计划中。

合并请求评论​

默认情况下，Cypress 会在运行完成时发布一个 MR 评论，总结运行情况。它将包括测试结果、运行信息和失败或不稳定测试的摘要。

你可以在项目的项目设置页面管理此行为。

项目设置页面切换合并请求评论以切换运行状态评论
tip
调试Cypress Cloud测试运行？

不要依赖本地复现失败条件或人工解析测试产物。使用 测试回放功能，完整重现录制运行期间的测试执行过程，获得全面的调试能力。

卸载 GitLab 集成​

你可以通过访问组织的集成 → GitLab 或企业版 GitLab 集成页面来移除此集成。这将停止所有来自 Cypress 的提交检查和 MR 评论。

目录