用户指南 - developer-res-cbc-cn.obs.cn-north-1 ...€¦ · 2 新建流水线...

流水线

用户指南

文档版本 06

发布日期 2017-05-12

华为技术有限公司

版权所有 © 华为技术有限公司 2017。保留一切权利。

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传

播。

商标声明

和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或

特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或默示的声

明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文

档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

华为技术有限公司

地址：深圳市龙岗区坂田华为总部办公楼邮编：518129

网址： http://www.huawei.com

客户服务邮箱： [email protected]

客户服务电话： 4008302118

文档版本 06 (2017-05-12) 华为专有和保密信息

版权所有 © 华为技术有限公司

i

http://www.huawei.com

mailto:[email protected]

目录

1 登录流水线首页............................................................................................................................... 1

2 新建流水线....................................................................................................................................... 3

3 修改/删除流水线..............................................................................................................................5

4 执行流水线..................................................................................................................................... 11

5 查看流水线..................................................................................................................................... 13

6 常见问题......................................................................................................................................... 166.1 如何使用流水线？...................................................................................................................................................... 176.2 如何配置执行参数？.................................................................................................................................................. 18

流水线用户指南目录

文档版本 06 (2017-05-12) 华为专有和保密信息版权所有 © 华为技术有限公司

ii

1 登录流水线首页

介绍登录流水线首页的操作步骤。

操作步骤

步骤1 登录软件开发云首页，在上方功能菜单区单击“服务 > 流水线”。

进入到“流水线”首页，如图1-1所示。

图 1-1 流水线首页

步骤2 在左上方可以查看租户下流水线总数、执行总次数和执行成功率，以及最近七天的执行成功率分布。

步骤3 在左下方可以查看到与当前用户相关的流水线任务。

流水线用户指南 1 登录流水线首页


1

l 流水线任务支持在文本框中输入名称关键字进行搜索。

l 流水线任务支持列表模式和卡片模式显示，默认为卡片模式显示。

l 将鼠标移到流水线任务名称上，即显示名称链接，单击名称链接进入5 查看流水线。

步骤4 单击左下方“新建流水线”可以新建流水线。

步骤5 在右侧可以查看与当前用户相关的最新消息。

l 单击“更多”，显示更多消息动态。

l 如果没有消息，即显示“暂无动态”。

l 单击消息节点，进入到对应消息详情页面。

----结束

流水线用户指南 1 登录流水线首页


2

2 新建流水线

介绍新建流水线的操作步骤。

操作步骤

步骤1 登录流水线首页。

步骤2 单击流水线首页“新建流水线”。

进入“新建流水线”页面，如图2-1所示。

说明

新建流水线的方式还有一种从项目中进行创建，操作如下：

1. 登录项目管理首页。

进入到项目“看板”页面。

2. 单击左侧导航“流水线”菜单。进入到项目中的流水线页面，单击“新建流水线”。

流水线用户指南 2 新建流水线


3

http://support.hwclouds.com/usermanual-projectman/ug/devcloud_hlp_00118.html

图 2-1 新建流水线

表 2-1 参数说明

参数项说明

流水线名称流水线的名称。

归属项目选择流水线所属的项目。

说明

l 归属项目下拉框中的选项为已经创建且当前用户具有权限的项目。

l 如果没有项目，请先新建项目。

说明

新建流水线时可以为流水线添加阶段、为阶段添加任务、设置条件参数等。

步骤3 设置完参数信息，单击“新建”。

进入流水线详情页面。

----结束

流水线用户指南 2 新建流水线


4

http://support.hwclouds.com/usermanual-projectman/ug/devcloud_hlp_00021.html

3 修改/删除流水线

介绍修改、删除流水线的相关操作。

前提条件

l 项目经理、开发人员或创建者可以修改流水线。

l 项目经理或创建者可以删除流水线。

操作步骤


步骤2 在流水线首页下方搜索目标流水线（如“pipeline02”），单击流水线的按钮。

进入配置流水线页面，如图3-1所示，可根据需要修改流水线名称、为流水线添加阶段、为阶段添加任务、设置条件参数等。

流水线用户指南 3 修改/删除流水线


5

图 3-1 配置流水线

步骤3 给流水线添加阶段。

单击，给流水线添加阶段；如果需要添加多个阶段，依次单击即可，如图3-2所示。

图 3-2 添加阶段



6

添加阶段后，根据实际需要修改、删除阶段或继续添加阶段，操作说明如表3-1所示。

表 3-1 阶段操作说明

操作项说明

添加阶段

单击，可以给流水线添加新的阶段。

修改阶段单击，弹出“通用配置”区域，根据需要修改阶段名称、设置任务执行模式（串行或并行），如图3-3所示。

图 3-3 通用配置

说明流水线阶段下任务的执行模式可以清晰分辨（串行或并行）。

删除阶段单击，根据删除提示确定删除阶段。

步骤4 给流水线中的阶段添加任务。

阶段添加后，仅有一个“默认任务”；如果需要添加多个任务，请单击“添加任务”。添加好的任务显示在“任务列表”中。

任务添加后，请根据实际需要修改、删除或继续添加任务，操作说明如表3-2所示。

表 3-2 任务操作说明

操作项说明

添加任务单击“添加任务”，可以给流水线中的阶段添加新的任务。



7

操作项说明

修改任务将鼠标移至任务所在行，会出现添加、编辑和删除任务的窗口，单击“编辑任务”按钮弹出“任务详情”区域。

根据需要修改任务名称、设置任务类型（构建、子流水线、代码检查或部署），选择需要调用的任务，如图3-4所示。

图 3-4 任务详情

说明

l 任务类型目前支持如下四种：

– 构建与当前用户相关的所有编译构建任务。

– 子流水线与当前用户相关的所有流水线。

子流水线只能调用一级，如果流水线任务中已经存在子流水线，则不能选择。

– 代码检查与当前用户相关的所有代码检查任务。

– 部署与当前用户相关的所有部署任务。

l 请选择需要调用的任务根据任务类型显示。如果没有选择到合适的任务，请根据界面提示进行创建。

l 如果调用的任务有参数，参数也会显示出来。

删除任务单击按钮，根据删除提示确定删除任务。



8

步骤5 （可选）添加完流水线并设置好各任务后，根据需要添加执行的条件参数。

单击“开始”中的“添加参数”添加执行参数；如果需要添加多个参数，继续单击

“添加参数”。添加好的参数显示在“参数列表”中。单击按钮，弹出“通用配置”区域，根据需要设置参数信息，如图3-5所示。

图 3-5 通用配置

说明

l “开始”名称不能修改。

l 在“参数列表”中设置参数名称以及默认值。

设置执行参数后，在执行流水线时，会弹出该执行参数，提示设置执行参数值。

l 参数类型分为“字符类型”、“部署类型”和“自定义类型”。

– “字符类型”即普通的文本类型，用于文本类型的参数。

– “部署类型”参数用于部署任务，包括“安装”、“升级”、“卸载”和“回滚”，根据需要在下拉列表中选择。

– “自定义类型”参数可以自己设置参数的枚举值，多个枚举值以分号隔开，在执行和选择参数默认值的时候，该值以下拉列表的形式展示。

l 根据实际需要可以添加多个执行参数。

步骤6 设置完流水线各项操作后，单击“保存”。

进入“流水线”详情页面。

步骤7 单击可删除对应流水线。

弹出删除确认提示框。请根据实际情况确定删除。

说明

只有流水线创建者、项目经理和项目创建者可以删除流水线。

步骤8 （可选）单击流水线名称链接，可以查看流水线详情。



9

说明

查看流水线详情请单击这里。

----结束



10

4 执行流水线

介绍执行流水线的操作步骤。

前提条件

l 流水线已建立并具有权限。

l 创建者、项目经理和开发人员可以执行流水线。

操作步骤


步骤2 在流水线首页下方搜索目标流水线。

步骤3 单击流水线所在区的“开始执行”启动执行。

此时，“开始执行”按钮由“正在启动”显示为“停止执行”，执行完成后，恢复为“开始执行”。

说明

单击“开始执行”，如果流水线设置了执行参数，会弹出执行参数提示框，根据需要设置执行参数值。

步骤4 （可选）在执行过程中，单击“停止执行”按钮。

弹出确认停止执行提示框，单击“确定”。

步骤5 （可选）查看流水线相关信息。

流水线相关信息如表4-1所示。

流水线用户指南 4 执行流水线


11

表 4-1 流水线信息

参数项说明

执行状态

有三种状态：

l 灰色流水线从未执行或上一次执行被中止

l 绿色上一个执行成功

l 红色上一个执行失败

上次执行时间

最近一次执行流水线的时间。

归属项目

流水线所属的项目。单击归属项目的名称链接，可以进入到项目中的流水线页面。

创建者流水线的创建人。

步骤6 （可选）查看流水线详情。

单击流水线名称，进入流水线详情页面，可查看工作空间、执行历史、计划配置和通知等，详情请单击这里。

----结束

流水线用户指南 4 执行流水线


12

5 查看流水线

介绍查看流水线的相关操作，包括工作空间、执行历史和、计划配置和通知，涉及的操作包括下载软件包、查看日志，根据需要构建或检查任务、修改或删除流水线等。

操作步骤


在首页可以查看与当前用户相关的流水线。

步骤2 输入名称关键字搜索目标流水线，单击流水线名称。

进入流水线详情页面，默认显示“工作空间”页面，可修改/删除流水线、查看最近执行结果和日志、下载软件包等，如图5-1所示。

图 5-1 工作空间

工作空间相关操作如表5-1所示。

流水线用户指南 5 查看流水线


13

表 5-1 工作空间操作说明

操作项说明

修改单击按钮，进入修改流水线页面。

删除单击按钮，根据删除提示可删除流水线。

开始执行

单击“开始执行”可以执行流水线。

下载将鼠标移至任务所在行，会出现添加、编辑和删除任务的窗口，单击可以下载对应构建包。

说明

l 只有“构建”类型的任务才有下载按钮。

l 如果构建包有多个，则会显示“下载全部”按钮，可以根据需要下载全部构建包。

查看日志

将鼠标移至任务所在行，会出现添加、编辑和删除任务的窗口，单击可以查看对应构建日志。

说明只有“构建”和“部署”类型的任务才有查看日志按钮。

查看检查报告

将鼠标移至任务所在行，会出现添加、编辑和删除任务的窗口，单击可以查看对应的检查报告。

说明只有“代码检查”和“部署”类型的任务才有查看检查报告按钮。

选择执行任务

单击任务所在区域的可以选择需要执行的任务。

步骤3 单击右上角“执行历史”页签。

可以查看执行历史记录，包括执行序号、执行者、流水线状态、执行时间、执行时长等。

说明

l 单击构建序号链接，可以查看对应执行详情，即进入到“工作空间”页签。

l 构建历史显示最近5次的。如果最近5次均构建失败，则显示一条最近一次成功的记录。

步骤4 单击右上角“计划配置”页签。

进入“流水线定时执行”页面，可以根据实际情况设置计划周期。

计划周期类型分为：

l 不定时

即不设置定时时间，根据实际情况进行手动构建。

l 每日

设置每天的某一时间进行定时构建，格式为“HH:MM”，如每天八点，则填写“08:00”。

l 每周

设置每周某天的某一时间进行定时构建。构建日期为周一至周日，选中构建日期（如“周一”）后，再填写构建时间，“HH:MM”（如“08:00”）。



14

步骤5 单击右上角“通知”页签。

设置事件类型的通知状态，包括是否发送服务动态与邮件通知，请根据实际情况单击

（表示已开启）/ （表示未开启）进行设置，如图5-2所示。

图 5-2 消息通知

说明

默认服务动态通知都发送，邮件通知都不发送。

----结束



15

6 常见问题

关于本章

介绍流水线服务中涉及的FAQ、典型场景或案例。

6.1 如何使用流水线？

6.2 如何配置执行参数？

流水线用户指南 6 常见问题


16

6.1 如何使用流水线？

流水线（CloudPipeline）提供可视化、可定制的自动交付流水线，帮助企业缩短交付周期，提升交付效率。

操作流程

介绍进入“流水线”服务页面后，流水线的基本使用流程：新建流水线、设置流水线、执行流水线等。

基本使用流程如图6-1所示。

图 6-1 基本使用流程

表 6-1 流程说明

流程说明

新建流水线进入“流水线”服务，单击“新建流水线”进行创建。

设置流水线单击流水线所在区域的进入流水线配置页面，可以给流水线新增阶段，为阶段新增任务，根据需要添加执行的条件参数等。

执行流水线单击流水线所在区域的“开始执行”启动执行。

说明执行流水线时，可以选择指定任务进行执行，即选中的任务才执行，不选中的任务不执行。



17

6.2 如何配置执行参数？

配置执行参数，用户可以根据自定义的条件参数执行任务，主要分为两种：编译构建参数和流水线参数。

说明

l 配置执行参数后，在执行构建任务时，会弹出执行参数，可根据需要为参数赋值，否则使用参数默认值。

l 执行参数引用形式为${ParameterName}，如“${Branch}”，其中“Branch”为已经添加的执行参数名。

编译构建参数

构建任务参数目前主要应用于两个场景：指定分支和配置构建包信息。

l 场景一指定分支

a. 进入构建任务“基本信息”页面，单击“添加参数”按钮，为分支信息添加参数如“Branch”，并设置好默认值，如图6-2所示。

图 6-2 添加分支参数

b. 单击“下一步”，在“代码配置”页面将“分支”信息配置成引用参数形

式，如图6-3所示。

图 6-3 引用分支参数



18

说明

其中“Branch”为第一步已经添加的执行参数，且需与参数名保持一致。

c. 构建任务时根据需要为执行参数赋值，自定义构建不同分支，如图6-4所示。

图 6-4 自定义分支

说明

执行参数值默认为添加参数时为参数设置的默认值，可根据需要进行修改。

l 场景二配置构建包信息

a. 进入构建任务“基本信息”页面，单击“添加参数”按钮，为构建包信息添加参数并设置好默认值，如图6-5所示。

图 6-5 添加构建包参数

b. 单击“下一步”，进入“构建配置”页面，“编译构建后”选择“上传归档包到编译构建仓库”，并将相应构建包信息配置成引用参数形式，如图6-6所示。



19

图 6-6 引用构建包参数

说明

其中“GroupId”、“ArtifactId”、“Version”和“Type”为第一步已经添加的执行参数，且需与参数名保持一致。

c. 构建任务时根据需要为执行参数赋值，自定义构建包信息，如图6-7所示。

图 6-7 自定义构建包信息

说明


流水线参数

流水线的参数，主要用于子任务，以构建任务为例。

1. 进入流水线配置页面，单击“开始”节点所在区的进入编辑页面，单击“添加参数”按钮，为流水线添加参数并设置好默认值，如图6-8所示。



20

图 6-8 添加流水线参数

说明

流水线参数分为“字符类型”、“部署类型”和“自定义类型”。

l “字符类型”即普通的文本类型，用于文本类型的参数。

l “部署类型”参数用于部署任务，可通过下拉列表选择默认值。

l “自定义类型”可以自己设置参数的枚举值，多个枚举值以分号隔开，在执行和选择参数默认值的时候，该值以下拉列表的形式展示。

2. 单击“阶段_1”所在区的，进入任务详情页面，并将任务参数配置成引用参数形式，如图6-9所示。



21

图 6-9 引用流水线参数

说明

其中“Param_1”为第一步已经添加的参数，且需与参数名保持一致。

3. 执行流水线时根据需要为执行参数赋值，自定义构建子任务信息，如图6-10所示。



22

图 6-10 自定义子任务信息

说明




23

用户指南 - developer-res-cbc-cn.obs.cn-north-1 ...€¦ · 2 新建流水线...

Documents