产品文档

本译文为机器生成(测试版)。以英文指南为准。

评审与晋级

持久化环境与 CI & Review

创建长期运行的共享环境,设置 CI 评审流程,通过 QA 证据评审合并事件,在 Console 中合并,并晋级已验证的候选版本。

客户管理员客户成员平台运营人员

最近更新

安全示例数据中的 CI & Review:团队摘要、Intake、Review、QA、Target QA 和 Merge 流程条、工作区标签页以及两条合并请求。
安全示例数据:CI & Review 跟踪每个合并事件从接收到合并的全过程。

Environments(/environments)和 CI & Review(/ci-review)是 Console 的共享验证工作流程。团队需要长期运行的 QA、UAT、演示、预发布或客户评审运行环境,并希望变更在晋级前通过代码评审和 QA 时,就可以使用它们。

持久化环境不是个人工作区,而是有独立策略、计费和事件历史的团队共享运行环境。CI 工作区配置文件会告诉 Console:合并事件需要浏览器、数据库或代码智能检查时应使用哪个 Review 或 QA 运行环境。

谁可以查看

有团队的每个人都可以在导航的发布区域中找到这两个页面,包括团队成员、团队管理员以及平台运营人员和管理员。团队策略决定谁可以创建环境和 CI 配置文件。如果看不到创建按钮,或操作被拒绝,请联系团队管理员。

开始之前

  • 为代码库连接 Git 提供方(设置 → Git 访问权限)。
  • 为初始数据准备已批准的数据库备份(备份)。
  • 决定该流程只检查源分支,还是也以持久化环境作为目标。此选择会改变运行的检查项目。

持久化环境

Persistent Environments(“为团队环境创建和运行持久化工作区”)列出团队环境、队列、详情和检查器。标题旁的 (i) 会介绍此页面并链接到本指南。

创建持久化环境

选择Create environment(/environments/new)。向导包含四个步骤:来源、运行时、政策和Review,以及一个会列出所有阻塞事项的启动面板。

  1. 来源:设置团队、环境名称、代码库 URL 和源分支。Console 会检查提供方访问权限。若运行时代码库和产品代码库必须按顺序检出,请启用代码库堆栈。
  2. 运行时:选择持久化环境配置文件、模板系列、工作区目标和规格。配置文件会设置 WebCentral 版本(Java、Gradle、Tomcat 和许可证包)。
  3. 政策:选择初始备份、暴露方式和数据库迁移引擎(Flyway、ARCHIBUS DUW 或无)。
  4. Review:检查计划,然后选择Create environment。此处会显示所选期限的运行时间价格。

安全示例数据中的持久化环境:环境队列旁显示所选环境的状态、候选版本、晋级和工作区操作。

Console 会创建记录并启动后端工作区。随后,环境会显示其持久化工作区、候选版本和当前版本、更新状态、运行时快捷方式及事件历史。任何能查看环境的人都可以通过铅笔按钮重命名环境。重命名只会更改显示名称。

运行时快捷方式

操作适用情况
Open workspace需要打开后端工作区的编辑器或 Shell。
Open Archibus需要打开 Tomcat /archibus 应用。
Restart Tomcat需要以受控方式重启 Tomcat。
Open archibus.log需要查看近期应用程序日志证据。
Open CI & Review需要查看此环境的评审、QA 和晋级历史。

分两个阶段更新环境

共享环境不会意外重启:

  1. Request environment update会批准更新,但暂时不会触碰正在运行的环境。
  2. Start environment update会启动更新并等待完成。状态先变为运行中,随后变为已应用。

安全示例数据中的环境,显示已验证的候选版本和已申请的更新。

CI & Review

CI & Review(“通过接收到批准、工作区 QA、目标环境验证和人工合并,逐步处理合并事件”)用于评审和合并变更。标题旁的 (i) 会介绍此页面并链接到本指南。

流程条会显示所选合并事件的阶段:摄入量、Review、QA、Target QA 和 Merge。下方有五个带计数的标签页:

标签页内容
Merge events评审队列:来自 Webhook、工作区交接或手动登记的所有合并事件。
Review所选合并事件(Review workspace):分支、评审者、堆叠变更,以及启动评审和 QA 的控件。
Run detail运行详情、阶段时间线和已清理敏感信息的日志行。
Repository routes已保存的 CI 工作区配置文件。加载流程的提供方设置或启动一次运行。
Provider handoff所选流程的提供方连接、Webhook 和流水线详情。

创建 CI 工作区配置文件

选择Create CI profile(/ci-review/workspaces/new)。步骤依次为Source route、工作区运行时、Run policy以及Review and create。

  1. Source route:设置团队、提供方、代码库、分支,以及可选的目标环境。选择目标环境会启用目标检查。
  2. 工作区运行时:选择 Review、QA、Review 加 QA 或目标 QA,并设置 CI 模板、目标和规格。
  3. Run policy:设置保留期、工件、运行阶段、QA 范围、迁移引擎、WebCentral 版本配置文件和数据库备份。
  4. Review and create:检查表格,然后选择Create CI profile。

配置文件记录的是流程元数据,并非个人工作区。合并事件需要 Review 或 QA 工作区时,Console 会使用该配置文件。

设置提供方交接

在Provider handoff中加载流程,然后:

  • 使用获准的凭据引用保存托管连接。保存后,Console 才会显示预览。
  • 选择Rotate credential或Revoke credential。
  • 选择Install webhook、Reconcile webhook或Remove webhook。
  • 依赖此流程前,先选择Check connection。

切勿将提供方令牌放在流程名称、说明或 QA 备注中。

实施评审

实施评审会将计划中的变更(通常是设计中获批的问题)转化为已合并代码:

  1. 开发人员在工作区中实现问题并推送分支。
  2. 变更通过提供方 Webhook、工作区交接或手动登记进入Merge events。
  3. 在Review中检查源分支和目标分支、提供方链接、评审者及堆叠变更。分配评审者并添加备注。
  4. 选择Start review & QA。ArchiBot 评审会检查代码、堆叠差异、缺失的测试和高风险路径。Runner QA 会收集执行证据:浏览器冒烟测试、数据库检查、测试命令和工作区日志。参见 Console 机器人。
  5. 查看流程条和Run detail。使用Cancel run可停止一次运行。

只有在以下条件满足时,Merge in Console才会启用:

  • 已记录评审者批准;
  • 所请求的代码评审已通过;
  • 所请求的 Runner QA 已通过;并且
  • 如果选择了目标环境,目标环境检查也已通过。

默认由人工合并。合并后可以晋级候选版本:在 Environments 中选择Promote candidate,前提是最新运行与该候选版本一致,然后按上述两个阶段更新环境。

仅检查源分支,还是同时检查目标环境

未选择目标环境时,Console 会运行代码评审和 Runner QA,并将 Target QA 标记为已跳过。选择目标环境后,Console 还会在合并或晋级前,根据该环境的数据库、备份、迁移引擎、目标、模板、工具链和参数验证候选版本。环境和两个 QA 配置文件必须使用相同的 WebCentral 版本配置文件。

安全示例数据中的合并事件评审标签页:批准门槛和合并就绪情况,包括人工评审者、ArchiBot 评审、Runner QA、目标 QA 和在 Console 中手动合并。

日志与证据

保存到 Shared Drive可将证据保留超过常规日志保留期限。此操作需要可写云盘。合并前,评审者应能在 Console 中确认:变更内容、运行的检查,以及已清理敏感信息的证据位置。切勿分享密钥、提供方令牌、Cookie、集群机密、数据库 URL、备份内容或许可证文件。

在手机上

  • Environments会将队列、详情和检查器垂直排列。选择某个环境后,页面会滚动到其详情。
  • 在向导中,Create environment和Create CI profile会固定在屏幕底部。启动面板和评审卡片中的重复按钮会隐藏,因此只显示一个主要按钮。
  • 配置文件向导中的 CI 提供方表格会变成带标签的卡片。
  • CI & Review 标签页可以左右滚动;评审者、运行和合并请求链接都有适合触控的完整尺寸目标。
  • 构建日志和其他对话框会以全宽面板打开。每个标题旁的 (i) 弹出框都适配屏幕。

安全示例数据中的手机创建环境页面:显示配置文件、模板、规格、运行时间和迁移卡片,创建环境按钮固定在底部。

安全示例数据中的手机创建 CI 工作区配置文件页面:提供方选项显示为全宽卡片,创建 CI 配置文件按钮固定在底部。

故障排除

阻塞项通常含义下一步
缺少代码库访问权限Console 无法确认 Git 访问权限。刷新凭据,或打开Manage Git access。
缺少目标或模板没有匹配的目标或模板别名。请团队管理员或 ISM 检查目标是否就绪。
未选择备份环境或 QA 配置文件需要初始数据。选择已批准的备份。
缺少迁移策略未选择迁移引擎。选择与目标匹配的引擎。
目标环境检查受阻Review 和 QA 已通过,但目标证据检查失败。合并前查看运行时间线。
Promote candidate已禁用候选版本缺失、已过期或尚未验证。重新运行 Review 和 QA,或选择正确的分支。

联系支持团队时,请提供团队、环境名称、合并事件或运行 ID、分支、受阻阶段以及已清理敏感信息的错误内容。参见支持交接。

相关指南

完成标志

  • 环境与 CI 配置文件使用相同的 WebCentral 版本配置文件。
  • 在合并前,可在 Console 中查看 Review、QA、目标环境检查和合并状态。
  • 保存到 Shared Drive 的日志不包含机密信息。