文档

预览与临时项目

用于实验的临时项目,以及可在审批前查看任务变更效果的预览功能。

这两种相关功能的目的都是将实验性工作与核心业务工作隔离开来。

临时项目

临时项目是一种你打算丢弃的普通项目。你可以用它来在陌生的代码库中测试Coroid,在广泛应用前验证策略变更,或是探索尚未确定的方案。

其价值在于隔离性。临时项目中的实验不会污染团队所依赖的项目任务历史、指标或上下文信息。

使用完毕后即可删除它们。如果一个临时项目存续了六个月,那它实际上已经变成了正式项目,却并未经过相应的配置维护。

预览环境

预览指的就是基于任务生成的分支所构建的、正在运行的应用。

这一点至关重要,因为有些问题无法通过查看代码差异来判断。页面是否能正确渲染、流程是否能端到端运行、变更效果是否达标——这些都需要应用实际运行才能确认。

预览就是浏览器测试的运行对象,也是审核人员无法仅凭截图就下定论时打开查看的内容。

预览任务的变更

在Factory中,打开等待审核的任务。在“变更内容”下方,预览窗口可一键启动任务的对应分支。

  1. 开始一键操作

    coroid/landing-hero
    60 分钟后停止
  2. 代码构建正在启动

    coroid/landing-hero
    正在启动预览…
  3. 直接使用即可已就绪

    a1b2c3d4-….preview.coroid.ai
    剩余 58 分钟

内容在 Coroid 沙箱环境中构建,若您已连接 Vercel 则可直接部署到 Vercel。仅限本地的代码库始终使用 Coroid 沙箱。

从评审面板启动预览,等待其加载完成后,点击进入运行中的分支。Coroid 预览会在 1 小时后自动停止。
  • 正在启动:分支的依赖项会被安装,应用程序随之启动。首次运行可能需要几分钟时间。
  • 就绪:运行中的应用程序会显示在窗口内。打开会在新标签页中显示该预览,窗口还会显示预览剩余的运行时长。
  • 停止会提前终止预览。在Coroid中运行的预览会在1小时后自动停止。

如果构建失败,重试会重新启动预览,查看日志会显示具体的出错原因。对于没有网页可打开的变更,比如后端或库变更,会显示浏览器中无内容可显示而非按钮。

如果正在启动或已运行的预览被再次触发,系统会直接打开同一个预览,从而避免两名审核人员启动两个副本。

预览的运行位置

你无法选择预览的运行位置:

  • Coroid沙箱:这是默认选项。Coroid会在隔离容器中构建任务分支,该容器不会获取任何机密信息。它无需pull request且无需推送操作,因此也适用于存储在Coroid内的代码库。
  • Vercel:当项目已关联Vercel以实现直接部署时(项目设置 →集成 → 审核证据),Vercel会构建对应分支并在Vercel预览地址上提供服务。Vercel自身的部署保护机制会生效,因此预览会在新标签页中打开,而非在窗口内显示。

处于仅本地模式的代码库永远不会离开Coroid,始终会在Coroid沙箱中预览。

预览地址较长且难以猜测,但拥有该地址的人就能在预览运行时打开它。请将其视为任何未发布内容的链接对待。

pull request 如何呈现预览效果

pull request中的Coroid为任务生成的预览链接如下:在Coroid中预览此变更会打开任务的审核页面并启动预览。该链接需要Coroid登录凭证;预览地址本身不会发布在拉取请求中。

如果您已有预览部署环境——无论是来自托管服务提供商的Git应用还是CI系统,Coroid也会将其关联进来。审核依据因此相关链接会直接显示在变更内容旁,无需额外查找。

核心是验证依据和其所验证的代码应当同步呈现。

何时选用哪种方式

  • 尝试使用Coroid,或探索可能弃用的方案 →临时项目
  • 验证特定变更是否表现正常 →预览

二者可结合使用:临时项目也能像其他项目一样拥有预览功能。