文档中心

云码工场DevSpace用户指南

最近更新时间：

7 项目

7.1 项目管理

7.1.1 创建项目

(1) 在 DevSpace 平台左侧导航栏，选择项目，进入项目页。
(2) 单击“创建项目”。
(3) 根据参数说明，填写项目信息后，单击“确定”。

7.1.2 查看、编辑项目

在项目页：
• 单击目标项目操作列的“详情”，可以查看该项目信息。
• 单击目标项目操作列的“编辑”，可以修改项目信息。

7.1.3 删除项目

限制与指导
• 只有项目管理员才可以删除项目。
• 删除后不可恢复，请谨慎操作。
• 删除项目后，项目内相关需求域内容、代码库、流水线等资源，以及项目成员设置、构建配置、测试环境等资源同步删除
• 删除项目后，项目与产品关联关系解除绑定，产品内关于项目的需求、版本关联关系自动删除，流水线引用在执行时报错，流水线需要增加校验，提示被调用的流水线不存在。
• 删除项目后，从产品创建分配到项目的缺陷，在项目中删除，但是在产品中保留。
操作步骤
(1) 在 DevSpace 平台左侧导航栏，选择项目，进入项目页。
(2) 找到需要删除的项目，单击其操作列的“删除”，弹出提示对话框。
(3) 按照界面提示在输入框中输入完整的项目名称，单击“确定”。

7.2 项目概览

在项目页，单机目标项目名称，进入项目概览页，即可在项目内协作。
项目概览页展示了待办事项、事项状态分布、迭代进度、版本进度、需求吞吐趋势、缺陷变化趋势、代码概览和流水线。

待办事项
展示当前账号在当前项目下未关闭的用户故事、任务、缺陷。
• 指派给我的：指派给当前账号的待办事项。
• 我创建的：当前账号创建的待办事项。
事项状态分布
展示当前项目的事项状态分布情况，包括总事项、已完成、进行中、未开始的事项。
迭代进度
展示当前项目的迭代进度，可单击“查看全部迭代”，快速进入全部迭代列表查看。
版本进度
展示当前项目的版本进度，可单击“查看全部版本”，快速进入全部版本列表查看。
需求吞吐趋势
展示当前项目提出需求数和完成需求数趋势图。
缺陷变化趋势
展示当前项目提出缺陷数和完成缺陷数趋势图。
代码概览
展示当前项目代码情况，包括应用、代码库、近 7 天提交。
流水线
展示当前项目流水线情况，包括流水线总条数、执行次数、执行成功和执行失败数。
可单击“查看全部流水线”，快速跳转到流水线列表查看全部流水线。

7.3 项目需求

7.3.1 需求概述

在项目协作中，可通过史诗、特性、用户故事多层结构来管理需求。

7.3.2 创建史诗

(1) 在项目页单击目标项目名称，进入项目概览页。

(2) 在左侧导航栏选择“协作 > 需求”，进入需求页。
(3) 单击“创建需求 > 史诗”，弹出创建史诗窗口。

(4) 根据参数说明，填写相关信息后，单击“确定”。

7.3.3 创建特性

(1) 在项目的左侧导航栏，选择“协作 > 需求”，进入需求页。
(2) 打开创建特性窗口：
单击“创建需求 > 特性”。

鼠标移至目标史诗的标题上，单击标题后的“+”。

(3) 根据参数说明，填写相关信息，单击“确定”。

7.3.4 创建用户故事

(1) 在项目的左侧导航栏，选择“协同 > 需求”，进入需求页。
(2) 打开用户故事创建窗口：
单击“创建需求 > 用户故事”。

鼠标移至目标特性的标题上，单击标题后的“+”。

(3) 根据参数说明，填写相关信息后，单击“确定”。

7.4 项目版本

7.4.1 版本计划概述

版本计划概览页展示当前项目的版本列表以及未规划的工作项信息。
版本列表中包含从项目集继承过来的版本以及在项目中创建的版本，从项目集继承过来的版本，在版本名称前有项目集图标。
继承自项目集的版本，在项目中不允许往里规划工作项。

7.4.2 创建主版本

(1) 在项目的左侧导航栏，选择“协同 > 版本”，进入版本页。
(2) 单击“创建版本”，弹出创建主版本窗口。

(3) 根据参数说明，填写相关信息后，单击“确认”。

7.4.3 创建子版本

(1) 在项目的左侧导航栏，选择版本，进入版本页。
(2) 单击某一个版本卡片右上角的“+”，弹出创建子版本窗口。

(3) 根据参数说明，填写子版本信息后，单击“确认”。

7.4.4 管理项目版本

在版本计划页：
• 单击“删除版本”，可以删除指定版本。

• 单击“ ”，可修改版本信息。

7.4.5 规划版本

7.4.5.1 关联版本
(1) 在版本计划页，单击“未规划工作项”。
(2) 将未规划工作项关联到版本，可选择以下方式：
鼠标移至目标工作项，将其拖拽至目标版本。

勾选一条或多条工作项，单击“关联版本”，选择目标版本后，单击“确认”。

7.4.5.2 移除已关联工作项
• 选择某个版本，在工作项页签选中要移除的工作项，将其拖拽至其他目标版本。

• 勾选一条或多条工作项，单击“移除”，在弹出的确认窗口，单击“确定”。

7.4.5.3 创建风险
(1) 在选中的版本的风险页签，单击“创建风险”。

(2) 根据参数说明，填写风险信息，单击“确认”。

7.4.5.4 管理风险
更新风险状态
(1) 在选中的版本的风险页签，单击目标风险标题，进入风险编辑详情页面。
(2) 在风险状态框，更新风险状态。
(3) 单击“确认”。

删除风险
在目标版本的风险页签，单击目标风险操作列的“删除”，删除该风险。

7.4.5.5 查看版本详情、统计与发现的缺陷

详情
展示当前版本需求、缺陷的进度概览、检查项（当前版本是否已达发布标准）、风险情况、版本的基本信息、关联的应用。
统计
展示需求和缺陷的统计信息，如缺陷密度（缺陷数/用户故事数）、用户故事转测率（已提测的用户故事数/用户故事总数）、当前版本的燃尽图、缺陷的剩余和关闭趋势图。
发现的缺陷
展示当前版本发现的缺陷，包括缺陷编号、标题、解决问题版本、状态、严重程度、指派人、预计工时等信息。

7.5 迭代

7.5.1 迭代概述

除了采用版本对项目进行开发计划，DevSpace 还提供迭代管理研发流程。
将需求规划进迭代，并在迭代内将用户故事拆出前端、后端、测试等多个任务，支持进度跟踪。
提供用户故事、任务、缺陷等多种工作项看板功能，支持可视化拖拽更改工作项的状态，同一状态下，可拖拽需求对其优先级进行排序。
当前版本迭代状态及说明如下表：

7.5.2 创建迭代

(1) 在项目的左侧导航栏，单击“协同 > 迭代”，进入迭代页面。
(2) 单击“创建迭代”，弹出创建迭代窗口。

(3) 根据参数说明，填写迭代信息，单击“确认”。
创建迭代后，默认状态为“未开始。”

7.5.3 管理迭代

7.5.3.1 编辑迭代
(1) 选择目标迭代，单击右上角的“ > 编辑迭代”，弹出更新迭代窗口。

(2) 对迭代信息进行修改后，单击“确认”。
7.5.3.2 规划迭代
场景简介
• 未规划工作项同步了需求中所有的用户故事，不包含史诗和特性。
• 规划迭代，是从未规划工作项里按照项目规划和需求优先级，将用户故事移动到迭代的一个过程。
操作步骤
(1) 在项目的左侧导航栏，单击“协同 > 迭代”，进入迭代页面。
(2) 选择以下方式，规划迭代。
在未规划工作项里选中要规划的事项，单击“关联迭代”，选择迭代，将事项从未规划工作项规划进目标迭代。

使用鼠标将未规划工作项里的事项拖动至目标迭代。

7.5.3.3 启动迭代
限制与指导
迭代内至少有一个任务或缺陷，才可以被启动。
操作步骤
(1) 在项目的左侧导航栏，选择“协作 > 迭代”，进入迭代页面。
(2) 单击迭代右上角的“ > 启动迭代”，启动该迭代。

7.5.3.4 执行迭代
场景简介
在迭代中，可以将用户故事拆分为更小粒度的开发任务，比如前端任务、后端任务、测试任务等。
任务创建
(1) 在项目的左侧导航栏，选择“协作 > 迭代”，进入迭代页面。
(2) 打开创建任务窗口：
单击迭代右上角的“创建 > 任务”，弹出创建任务窗口。

在迭代的工作项列表，鼠标移至用户故事标题，单击“+ > 新建任务”，弹出创建任务窗口。

(3) 根据参数说明，完成信息填写后，单击“确定”。

管理任务
在“协作 > 迭代”页，单击目标迭代，进入该迭代的工作项页：
• 单击目标任务名称，查看该任务的详细信息，并可对具体信息进行修改。
• 进入任务详情页面后，单击右上角的“ > 删除”，删除该任务。
• 进入任务详情页面后，单击“ ”，复制任务链接，可在其他位置粘贴访问。
后续管理
• 结束迭代：选择目标迭代，单击右上角“ > 结束迭代”。
已结束迭代会移动到“已结束的迭代”列表，结束迭代前提是该迭代下的所有工作项必须都是已关闭状态；如果迭代有工作项处于非已关闭状态，迭代不能结束。
• 删除迭代：选择目标迭代，单击右上角的“ > 删除迭代”，删除该迭代。
若迭代里有工作项，系统会将该迭代下的工作项移动到未规划工作项列表。
• 重新启动迭代：已结束的迭代，若要继续进行迭代，需要在“已结束的迭代”列表选择该迭代，单击右上角的“ > 重新启动”。

7.6 缺陷

7.6.1 缺陷概述

缺陷可以在迭代里创建，在目标迭代下进行修复。

7.6.2 创建缺陷

(1) 在项目的左侧导航栏，选择“协作 > 缺陷”，进入缺陷页。
(2) 打开创建缺陷窗口：
在“协作 > 迭代”页面，单击迭代右上角的“创建 > 缺陷”，弹出创建缺陷窗口。
在“协作 > 缺陷”页面，单击“创建缺陷”，弹出创建缺陷窗口。
(3) 根据参数说明，完成信息填写后，单击“确定”。

7.6.3 管理缺陷

在“协作 > 缺陷”页，或“协作 > 迭代”页的目标迭代中，单击目标缺标题，弹出该缺陷详细信息页：
• 修改缺陷的详细信息，更新该缺陷。
• 单击右上角的“ > 删除”，删除该缺陷。
• 单击右上角的“ ”，复制缺陷链接，将该缺陷分享给其他人。

7.7 应用

7.7.1 应用概述

云码工场以应用的概念贯穿代码库、代码库对应的扫描和流水线；同时以应用概念对接微服务平台，进行应用全生命周期管理。

7.7.2 创建应用

(1) 在项目的左侧导航栏，选择“应用”，进入应用页。
(2) 单击“创建”，弹出创建应用窗口。

(3) 根据参数说明，填写相关信息后，单击“确定”。

7.7.3 管理应用

• 单击目标应用操作列的“详情”，查看该应用的详细信息。

• 单击目标应用操作列的“编辑”，编辑该应用的详细信息。

• 单击目标应用操作列的“删除”，删除该应用。

7.7.4 添加部署环境

(1) 在项目的左侧导航栏，选择“应用”，进入应用页。
(2) 单击应用名称，进入部署环境页。
(3) 单击“添加部署环境”，页面右侧滑出添加部署环境窗口。
(4) 根据参数说明，完成基本信息填写，单击“下一步”。
(5) 根据参数说明，完成部署流水线信息后，单击“确定”。

7.7.5 管理部署环境

在部署环境页：
• 单击目标环境右上角的，启动部署。
• 单击目标环境右上角的“ > 编辑部署环境”，编辑该部署环境。
• 单击目标环境右上角的“ > 查看部署环境”，查看该部署环境执行详情。
• 单击目标环境右上角的“ > 删除部署环境”，删除该部署环境。

7.8 代码托管

7.8.1 代码托管概述

代码托管统一管理企业内部代码资源，支持 Java、Python、Golang、C 语言、NodeJs 等常用开发语言，支持基于 Git 的代码托管。

7.8.2 创建代码库

代码库创建入口
代码库创建有三个入口：
• 入口一：在代码托管页创建代码库。
• 入口二：在流水线任务卡片中配置。
• 入口三：创建应用时，在关联代码库处创建，已在创建应用时介绍。
入口一
(1) 在项目的左侧导航栏，选择“代码 > 代码托管”，进入代码托管页。
(2) 单击“添加代码库”，页面右侧滑出创建代码库页。
(3) 根据参数说明，完成信息填写后，单击“确认”。

入口二
(1) 在项目的左侧导航栏，选择“流水线 > 流水线列表”，进入流水线列表页。
(2) 选择目标流水线，单击其操作列的“编排”。

(3) 在任务编排页，进行以下配置。
添加构建镜像任务卡片时，应用下勾选“从其他代码库导入 Dockerfile”，在代码库下选择“创建”，跳转到代码托管页。
添加 RobotFramework 测试任务卡片时，测试用例下选择“创建”，跳转到代码托管页。
添加 Pytest 测试任务卡片时，测试用例下选择“创建”，跳转到代码托管页。
添加 Helm 部署任务卡片时，应用下勾选“从其他代码库导入配置”，在代码库下选择“配置”，跳转到代码托管页。
(4) 单击“添加代码库”，填写相关信息，完成代码库创建。

7.8.3 文件管理

7.8.3.1 新建文件
(1) 在项目的左侧导航栏，选择“代码 > 代码托管”，进入代码托管页。
(2) 单击代码库名称，进入代码库文件管理页面。
(3) 单击页面上的“+ > 新建文件”。

(4) 输入新建文件名称和内容等信息，单击“确定”。
7.8.3.2 管理文件
• 单击左侧文件树中文件名称，查看文件内容。
• 在文件内容右上角，单击，可全屏显示、编辑、下载、删除文件。
• 单击“克隆/下载”，进行代码 SSH 或者 HTTPS 协议克隆，或者代码库压缩文件下载。

7.8.4 分支管理

(1) 在项目的左侧导航栏，选择“代码 > 代码托管”，进入代码托管页。
(2) 单击代码库名称，进入代码库文件管理页面。
(3) 单击分支页签。

(4) 单击“创建”，弹出新建分支窗口。
(5) 根据参数说明，填写分支信息，单击“确认”。

7.8.4.2 管理分支
在分支列表：
• 单击目标分支操作列的“下载”，选择下载格式，基于当前分支进行代码压缩文件下载。

• 单击目标分支操作列的“合并”，基于当前分支创建代码合并申请。

• 单击目标分支操作列的“删除”，删除该分支。
被保护的分支不支持删除。

7.8.5 标签管理

7.8.5.1 标签概述
在标签页可以给代码库创建标签，方便对代码库进行任意维度的分组管理。
7.8.5.2 创建标签
(1) 在项目的左侧导航栏，选择“代码 > 代码托管”，进入代码托管页。
(2) 单击代码库名称，进入代码库文件管理页面。
(3) 单击标签页签。

(4) 单击“创建”，弹出创建标签窗口。
(5) 填写标签基础信息，单击“确认”。

7.8.5.3 管理标签
• 单击目标标签操作列的“下载”，选择文件格式，基于当前标签下载代码压缩文件。
• 单击目标标签操作列的“删除”，删除当前标签。

7.8.6 合并请求

7.8.6.1 创建合并请求
(1) 在项目的左侧导航栏，选择“代码 > 代码托管”，进入代码托管页。
(2) 单击代码库名称，进入代码库文件管理页面。
(3) 单击合并请求页签。

(4) 单击“创建”，选择源分支和目的分支。

(5) 单击“确认”，进入新页面。

(6) 填写相关信息，单击“确认”。

7.8.6.2 审批请求
所选指派人账号登录，单击合入请求概览页签中的“合入”，完成代码合入请求审批。
可切换至提交或变更页签，查看对应的信息。

7.8.6.3 评审请求
如果创建合入请求时设置了代码评审人，则评审人可登录账号，在合入请求概览页的评审框中填写代码评审意见，并单击“确认”。

7.8.7 查看提交记录

(1) 在项目的左侧导航栏，选择“代码 > 代码托管”，进入代码托管页。
(2) 单击代码库名称，进入代码库文件管理页面。
(3) 单击提交记录页签，可针对某分支或者某已有标签进行代码提交记录搜索。
(4) 单击目标提交记录的 Commit ID，查看提交的详细信息。

7.8.8 成员&角色

7.8.8.1 角色概述
目前支持四种角色，维护者、开发者、报告者和访客。
• 维护者：拥有代码库最高权限。
• 开发者：拥有基础操作权限，无代码库设置权限。
• 报告者：拥有代码库报告权限，无实际操作权限。
• 访客：只可查看代码库，无其他操作权限。
7.8.8.2 添加成员
(1) 在项目的左侧导航栏，选择“代码 > 代码托管”，进入代码托管页。
(2) 单击代码库名称，进入代码库文件管理页面。
(3) 单击成员&角色页签，进入代码成员&角色管理页面。

(4) 单击“添加”，弹出添加成员窗口。

(5) 完成信息填写，单击“确认”。

7.8.8.3 管理成员
在成员&角色列表：
• 单击角色，可选择目标角色，为成员切换角色。

• 单击目标成员操作列的“删除”，移除代码库成员。

7.8.9 设置

7.8.9.1 设置默认分支
(1) 在项目的左侧导航栏，选择“代码 > 代码托管”，进入代码托管页。
(2) 单击代码库名称，进入代码库文件管理页面。
(3) 单击设置页签，进入代码库设置页面。
(4) 选择默认分支，单击“确认”。

7.8.9.2 添加保护分支
(1) 在项目的左侧导航栏，选择“代码 > 代码托管”，进入代码托管页。
(2) 单击代码库名称，进入代码库文件管理页面。
(3) 单击设置页签。
(4) 在保护分支列表，单击“添加”，弹出添加保护分支窗口。

(5) 根据参数说明，填写保护分支设置信息后，单击“确认”。

7.8.9.3 管理保护分支
在设置页签的保护分支列表模块：
• 在目标保护分支的允许合并列，选择角色，变更对应的操作权限。
• 在目标保护分支的允许推送列，选择角色，变更对应的操作权限。
• 单击目标保护分支操作列的“取消保护”，可取消保护分支。
7.8.9.4 高级设置
在设置页面的高级设置模块：
• 单击“编辑代码库”，可对代码库进行编辑。
• 单击“删除代码库”，可删除该代码库。

7.8.10 代码迁移

7.8.10.1 研发环境为 Linux
在 Linux 环境，进入要放新仓库的文件夹，执行以下命令：
(1) 在统一代码仓库对应的 group 下创建一个空的 project。
(2) 以 mirror 形式将代码克隆到本地。
git clone --mirror <旧的仓库地址>
(3) 切换到克隆下来的代码库根目录。
cd <刚 clone 的文件夹>
(4) 更新远程仓库为统一代码仓库的地址。
git remote set-url origin <新的仓库地址>
例如:git remote set-url origin ssh://git@xxx.xxx.xxx.xxx/home/mgitproject/xxx/xxx
(5) 将克隆下来的 mirror 版代码内容推送到统一代码仓库。
git push -f origin
如果出现“failed to push some refs to git”，请运行命令：git pull --rebase origin master。
7.8.10.2 研发环境为 Windows
操作步骤与 Linux 基本一致，区别是 Windows 环境需要使用本地 Git Bash 进行操作。

7.9 代码扫描

7.9.1 创建扫描任务

(1) 在项目的左侧导航栏，选择“代码 > 代码扫描”，进入代码扫描页。
(2) 单击“创建扫描任务”，弹出创建扫描任务窗口。

(3) 填写相关信息，单击“确定”。

7.9.2 扫描设置

7.9.2.1 触发条件设置
场景介绍
目前支持 Gitlab 代码端 Push、创建 Merge Request、创建 Tag 自动化启动扫描，以及定时和手动触发。可按需精确/模糊匹配 Merge Request 和 Push 要监控的分支。
编辑触发条件
(1) 在项目的左侧导航栏，选择“代码 > 代码扫描”，进入代码扫描页。
(2) 单击扫描任务名称，进入扫描任务详情页，默认展示扫描设置页签。
(3) 单击“触发条件”，切换至触发条件设置。
(4) 单击“编辑”，根据参数说明编辑信息。

(5) 单击“保存”。
7.9.2.2 编译脚本设置
限制与指导
创建扫描任务后，默认生成编译脚本信息，如有需要，对其进行编辑即可。
以 Java 语言的 Maven 编译为例，默认编译脚本和依赖库为官方，如果有需要专门的 Nexus 依赖库，可以通过上传 Setting 文件拉取。
编辑编译脚本
(1) 在项目的左侧导航栏，选择“代码 > 代码扫描”，进入代码扫描页。
(2) 单击扫描任务名称，进入扫描任务详情页，默认展示扫描设置页签。
(3) 单击“编译脚本”，切换至编译脚本设置。
(4) 单击“编辑”，根据参数说明，对编译脚本信息进行编辑。

(5) 单击“保存”。

7.9.2.3 配置扫描器
限制与指导
当前仅支持新增一个 SonarQube 扫描器。
新增扫描器
(1) 在项目的左侧导航栏，选择“代码 > 代码扫描”，进入代码扫描页。
(2) 单击扫描任务名称，进入扫描任务详情页，默认展示扫描设置页签。
(3) 单击“扫描器配置”，进入扫描器配置页。
(4) 单击“新增扫描器”，弹出新增扫描器窗口。
(5) 扫描器名称选择“SonarQube”，并选择对应的扫质量规则。

(6) 单击“确定”。
管理扫描器
在扫描器配置页：
• 单击目标扫描器操作列的“编辑”，编辑该扫描器质量规则。
• 单击目标扫描器操作列的“删除”，删除该扫描器。
7.9.2.4 设置质量门禁
场景介绍
创建扫描任务后，默认生成质量门禁，如有需要，对其进行编辑即可。
编辑质量门禁
(1) 在项目的左侧导航栏，选择“代码 > 代码扫描”，进入代码扫描页。
(2) 单击扫描任务名称，进入扫描任务详情页，默认展示扫描设置页签。
(3) 单击“质量门禁”，进入质量门禁页。
(4) 单击“编辑”，根据参数说明，完成设置。

(5) 单击“保存”。

7.9.3 执行扫描

场景介绍
扫描触发条件设置了 Push、Merge Request、Tag、定时触发的，在代码有相应变动时会自动触发扫描。
如果没有配置自动扫描规则，可以按需要手动触发。
手动执行扫描
(1) 在项目的左侧导航栏，选择“代码 > 代码扫描”，进入代码扫描页。
(2) 单击目标扫描任务操作列的“扫描”，弹出扫描窗口。
(3) 选择要执行扫描任务的分支或标签。

(4) 单击“确定”。

7.9.4 查看扫描结果

(1) 扫描完成之后，在代码扫描页，单击目标扫描任务名称，切换到扫描历史页签。
(2) 查看目标扫描历史的状态。
状态为“失败”时，可单击其操作列的“日志”，查看具体信息。
通过质量门禁，可以单击“查看”，查看其他代码扫描问题。

7.9.5 管理扫描任务

在代码扫描页：
• 单击目标扫描任务操作列的“编辑”，编辑该扫码任务。
• 单击目标扫描任务操作列的“删除”，删除该扫码任务。
• 单击目标扫描任务操作列的“启用/停用”，启用/停用该扫码任务代码端的自动触发。

7.10 测试管理

7.10.1 用例管理

7.10.1.1 创建用例分组
限制与指导
一个分组下最多可以创建 5 层子分组。
操作步骤
(1) 在项目的左侧导航栏，选择“测试 > 用例管理”，进入全部用例页。

(2) 在用例分组模块，添加分组或子分组。
单击全部分组后的“+”，添加分组。
单击目标分组后的“+”，添加子分组。
(3) 在输入框中，输入分组或子分组名称后，按“Enter”保存。
7.10.1.2 管理用例分组
• 鼠标悬浮至目标分组，单击其后的“ > 重命名”，可对该分组进行重命名。
• 鼠标悬浮至目标分组，单击目标分组后的“ > 删除”，可删除该分组。

7.10.1.3 创建测试用例
(1) 在项目的左侧导航栏，选择“测试 > 用例管理”，进入全部用例页。
(2) 单击“创建用例”，弹出创建用例窗口。

(3) 根据参数说明，填写相关信息后，单击“保存”。

7.10.2 测试计划

7.10.2.1 创建测试计划
(1) 在项目的左侧导航栏，选择“测试 > 测试计划”，进入测试计划页。
(2) 单击“创建测试计划”，弹出创建测试计划窗口。

(3) 根据参数说明，填写相关信息后，单击“确认”。

7.10.2.2 管理测试计划
在测试计划页：
• 选择状态为“新建”的目标测试计划，单击其操作列的“ ”，启动该测试计划。
• 选择状态为“进行中”的目标测试计划，单击其操作列的“ ”，结束该测试计划。
• 单击目标测试计划操作列的“ ”，编辑该测试计划。
• 单击目标测试计划操作列的“ > 复制计划”，复制该测试计划。
• 单击目标测试计划操作列的“ > 删除计划”，删除该测试计划。
测试计划状态说明如下表：

7.10.2.3 规划用例
(1) 在项目的左侧导航栏，选择“测试 > 测试计划”，进入测试计划页。
(2) 单击已创建的目标测试计划标题，进入该测试计划详情页。
(3) 选择规划用例方式：

单击“规划用例”，在弹出的规划用例窗口中，勾选需要规划进此计划的用例，单击“确定”。
单击“> 创建用例”，在弹出的创建用例窗口中，填写相关信息，完成创建后，自动规划在当前计划中。
7.10.2.4 管理测试计划中的测试用例
• 单击目标测试用例操作列的“ ”，执行该用例。
• 单击目标测试用例操作列的“ ”，复制该用例。
• 单击目标测试用例操作列的“ > 关联缺陷”，将该用例关联至一个或多个缺陷。
• 单击目标测试用例操作列的“ > 新建一个缺陷并关联”，新建一个缺陷，并与该用例关联。
• 单击目标测试用例操作列的“ > 从计划中移除”，将该用例从当前计划中移除。

7.10.3 接口测试

7.10.3.1 测试概览
在项目中的左侧导航栏，选择“测试 > 接口测试”，进入测试概览页。
测试概览页展示接口数量统计、接口用例数量统计、场景用例数量统计、场景定时任务数量统计、过去 7 天测试计划失败用例 TOP10、运行中的定时任务、过去 7 天有更新的接口等信息。

7.10.3.2 接口定义
切换接口协议
(1) 在项目中的左侧导航栏，选择“测试 > 接口测试”，进入测试概览页。
(2) 单击左上角的 HTTP 下拉框，可切换接口协议。目前支持 HTTP、TCP、SQL、DUBBO。
模块树管理
• 在页面左侧列框，鼠标悬浮至模块名称，单击其后的，在显示的框中输入新建分组的名称，可创建模块，最多可创建 8 级。
• 鼠标悬浮至分组文件夹，单击其后的，修改文件夹名称。
• 鼠标悬浮至分组文件夹，单击其后的，删除该文件夹。
• 拖拽模块可重新排列顺序。
创建接口
(1) 在接口定义页签，单击“更多操作 > 创建接口”。
(2) 输入名称、请求等信息，单击“确定”。
(3) 单击“编辑详情”，配置基础信息、Mock 服务、请求参数、响应内容等信息。
(4) 单击“保存”。
创建快捷调试
(1) 在接口定义页签，单击“更多操作 > 快捷调试”，弹出创建接口窗口。
(2) 填写完整的测试地址和基本请求参数，单击“测试”，即可进行接口调试。
测试完成后，单击“另存为新用例”，可保存为一个新的接口定义和接口用例。
API
在 API 页面中，可以对接口的基础信息、请求及响应定义、依赖关系进行详细编辑。
单击目标接口操作列的“”，可对此接口进行执行、编辑、管理 CASE、删除、复制等操作。
7.10.3.3 接口自动化
场景简介
场景是接口自动化功能中的基本管理单元，由一组用例和接口组装而成。例如用户管理场景，包含用户注册、用户登录、用户修改、用户注销、用户销户等用例或者接口。
创建场景
(1) 在接口自动化页签，选择一个模块后，单击“更多操作 > 创建场景”，弹出创建场景窗口。
(2) 仅填写基本信息，在该模块下快速创建接口。
(3) 单击“编辑详情”，进入场景详情编辑页面，对场景信息进一步编辑完善。
(4) 单击“保存”。
场景管理
在场景列表：
• 单击目标场景操作列的“”，对该场景进行执行、编辑、复制、删除操作。
• 单击目标场景操作列的“ > 查看引用”，查看场景引用情况。
• 单击目标场景操作列的“ > 定时任务”，编辑定时任务。
7.10.3.4 测试报告
在测试报告中可以查看场景用例中每个请求的请求详情及响应详情，同时提供了控制台日志、变量提取结果等信息的展示。

7.11 流水线

7.11.1 创建流水线

(1) 在项目的左侧导航栏，选择“流水线 > 流水线列表”，进入流水线列表页。
(2) 单击“创建流水线”，弹出创建流水线窗口。

(3) 选择模板，单击“下一步”。
(4) 填写流水线名称、描述和需要配置的应用。

(5) 单击“确定”。

7.11.2 编排流水线

7.11.2.1 流水线规则概述
流水线创建完成自动跳转任务编排页面，系统支持按照 Stage（阶段）、Group（任务序列）、Task（任务）三个层级进行任务编排，其中 Stage 之间是串行关系，Stage 内可以包含多个并行的Group，每个 Group 下可以包含多个串行的 Task。

7.11.2.2 任务编排
场景介绍
本文以 Maven 构建为例进行配置说明，其它编译构建可能与此有部分差异，请根据实际情况进行配置。
操作步骤
(1) 流水线完成创建后，自动跳转至任务编排页。或单击目标流水线操作列的“编排”，进入任务编排。
(2) 单击“开始编排”，默认创建准备阶段，可对其下的任务序列进行编辑。

(3) 单击准备阶段右侧的“+”，添加新的阶段。
(4) 单击“添加任务序列”，添加一个任务序列，可多次添加多个任务序列。
(5) 在任务序列框中，单击“添加”，在右侧滑的选择任务插件窗口中，选择 Maven 构建。

(6) 根据参数说明，完成信息配置后，单击“确认”。

(7) 单击“保存”，完成流水线任务编排。
可单击“保存并执行”，完成后直接执行该流水线。
管理任务编排
在任务编排页：
• 单击阶段名称后的“ ”对默认阶段名称进行修改，完成后单击“ ”。
• 单击阶段名称后的“ ”，删除此阶段。
• 单击任务序列右上角的“ ”，删除此任务序列。
• 单击任务名称右侧的“ ”，编辑此任务信息。
• 单击任务名称右侧的“ ”，删除此任务。
• 直接拖拽卡片进行任务排序，比如 Stage 顺序、Group 内的 Task 先后顺序。
7.11.2.3 基本设置
(1) 在项目的左侧导航栏，选择“流水线 > 流水线列表”，进入流水线列表页。
(2) 单击目标流水线操作列的“编排”。
(3) 单击基本信息，切换到基本信息页签。
(4) 单击“编辑”，根据需要对流水线基本信息进行编辑。

(5) 完成后单击“保存”。
7.11.2.4 触发设置
场景介绍
完成流水线各个阶段的任务编排后，在触发设置页签配置流水线触发设置，目前支持Gitlab代码端Push、创建 Merge Request、创建 Tag 自动化启动扫描，以及定时和手动触发。可按需精确/模糊匹配 Merge Request 和 Push 要监控的分支。
操作步骤
(1) 在项目的左侧导航栏，选择“流水线 > 流水线列表”，进入流水线列表页。
(2) 单击目标流水线操作列的“编排”。
(3) 单击触发设置，切换到触发设置页签。
(4) 单击“编辑”，根据参数说明，完成触发设置。

(5) 单击“保存”。
7.11.2.5 设置参数
场景介绍
系统支持自定义参数和环境变量两种类型的参数。当前支持系统默认环境变量，单击环境变量标签右侧“系统环境变量”链接查看。目前支持的参数类型为枚举类型和字符串类型，枚举类型参数值之间以“,”隔开。
添加自定义参数
(1) 在项目的左侧导航栏，选择“流水线 > 流水线列表”，进入流水线列表页。
(2) 单击目标流水线操作列的“编排”。
(3) 单击参数设置，切换到参数设置页签。
(4) 单击流水线参数模块的“添加参数”，弹出添加参数窗口。

(5) 根据参数说明，填写信息。

(6) 单击“确定”。
添加环境变量
(7) 在项目的左侧导航栏，选择“流水线 > 流水线列表”，进入流水线列表页。
(8) 单击目标流水线操作列的“编排”。
(9) 单击参数设置，切换到参数设置页签。
(10) 单击环境变量模块的“添加环境变量”，弹出添加环境变量窗口。
(11) 完成信息填写后，单击“确定”。

(12) 根据参数说明，填写信息。

管理参数
在流水线编排的参数设置页签：
• 单击目标参数或环境变量操作列的“编辑”，编辑此目标。
• 单击目标参数或环境变量操作列的“删除”，删除此目标。

7.11.3 执行流水线

场景介绍
流水线触发条件设置了 Push、Merge Request、Tag、定时触发的，在代码有相应变动时会自动触发流水线执行。
如果没有配置自动触发规则，可以在流水线列表手动执行流水线任务。
操作步骤
(1) 在项目的左侧导航栏，选择“流水线 > 流水线列表”，进入流水线列表页。
(2) 单击目标流水线操作列的“执行”，右侧滑出执行流水线窗口。
(3) 选择版本等信息后，单击“确认”。

7.11.4 查看流水线结果

在流水线列表，单击流水线名称，查看流水线历史执行状态。

• 在执行记录页签，单击序号或“查看详情”，查看流水线执行具体编排卡片的详细信息。
可单击“日志”，查看执行日志，日志支持全屏阅读和下载。

• 在执行记录页签，单击“启动参数”，查看执行实际调用的参数值。
• 在执行记录页签，单击“终止执行”，终止正在执行中的流水线。

7.12 项目配置

7.12.1 凭证管理

配置凭证入口
在项目中，配置凭证有四个入口：
• 在“项目配置 > 凭证管理”页面创建凭证。
• 在“应用”页面，创建应用时创建凭证。

• 在“流水线 > 流水线列表”页面，任务编排中，配置 RobotFramework 测试和 Pytest 测试任务卡片时，创建凭证。

• 在“项目配置 > 构建配置”页面，新增 Docker 构建配置时，创建凭证。
本章以下主要介绍在“项目配置 > 凭证管理”页面创建凭证，其他入口均在对应章节有所介绍。
创建凭证
(1) 在项目的左侧导航栏，选择“项目配置 > 凭证管理”，进入凭证管理页。
(2) 单击“创建凭证”，弹出创建凭证窗口。

(3) 根据参数说明，填写信息后，单击“确定”。

管理凭证
在凭证管理页：
• 单击目标凭证操作列的“查看”，查看该凭证的详情。
• 单击目标凭证操作列的“编辑”，编辑该凭证的详情。
• 单击目标凭证操作列的“删除”，删除该凭证。

7.12.2 构建配置

7.12.2.1 构建配置概述
构建配置应用在代码扫描或者流水线构建配置等任务卡片时调用。
• Maven：用于代码扫描与流水线 Maven 构建任务卡片。
• Docker：用于构建 Docker 镜像存储位置。
• Gradle：用于代码扫描和流水线 Gradle 构建任务卡片。
7.12.2.2 新增构建配置
(1) 在项目的左侧导航栏，选择“项目配置 > 构建配置”，进入构建配置页。
(2) 单击“新增构建配置”，弹出新增构建配置窗口。
(3) 选择构建工具类型，单击“确定”，进入下一步。

(4) 根据参数说明，填写相关信息，单击“确定”。

7.12.2.3 管理构建配置
• 单击目标构建配置操作列“编辑”，编辑该构建配置信息。
• 单击目标构建配置操作列“删除”，删除该构建配置。

7.12.3 资源配置

7.12.3.1 创建主机组
(1) 在项目的左侧导航栏，选择“项目配置 > 资源配置 > 主机组”，进入主机组页。
(2) 单击“创建主机组”，弹出创建主机组窗口。

(3) 根据参数说明，完成信息填写，单击“确定”。

7.12.3.2 管理主机组
在主机组页：
• 单击目标主机组操作列“编辑”，编辑主机组信息。
• 单击目标主机组操作列“删除”，删除主机组。
7.12.3.3 为主机组添加主机
(1) 在项目的左侧导航栏，选择“项目配置 > 资源配置 > 主机组”，进入主机组页。
(2) 单击目标主机组名称。
(3) 单击“添加主机”，弹出添加主机窗口。

(4) 根据参数说明，完成信息配置后，单击“确定”。

7.12.3.4 管理主机
在主机组的主机列表：
• 单击目标主机操作列的“编辑”，编辑该主机信息。
• 单击目标主机曹组列的“删除”，删除该主机。
7.12.3.5 新建 K8s 构建配置
(1) 在项目的左侧导航栏，选择“项目配置 > 资源配置 > K8s 配置”，进入 K8s 配置页。
(2) 单击“新增构建配置”，弹出新增构建配置窗口。
(3) 根据参数说明，完成配置，单击“确定”。

7.12.4 人员配置

场景介绍
人员配置应用于对一个项目中的人员和角色进行管理。
添加成员
(1) 在项目的左侧导航栏，选择“项目配置 > 人员配置”，进入人员配置页。
(2) 单击“添加成员”，弹出添加成员窗口。

(3) 在对应下拉框中选择一个或多个用户名和人员角色。
(4) 单击“确定”。
管理人员
在人员配置页：
• 单击目标角色操作列的“编辑角色”，编辑该角色。
• 单击目标角色操作列的“移除”，将该角色从项目人员中移除。

意见反馈

文档内容是否对您有帮助？

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服