云服务器内容精选

  • 查看流水线 访问CodeArts Pipeline首页。 流水线列表页展示当前用户下的所有流水线,列表项说明如下: 参数项 说明 名称 流水线名称和流水线所属项目名称。 说明: 项目下流水线列表不显示项目名称。 最近一次执行 最近一次的执行信息:执行方式、分支、最近一次代码提交的CommitID、执行人。 工作流 流水线的调度流程及执行状态(已完成、失败、运行中、已停止等)。 开始时间&执行时长 最近一次执行开始时间和持续时长。 操作 单击,可执行流水线。 单击,可关注流水线,关注成功后图标变为,再次单击可取消关注。 说明: 收藏流水线后,刷新页面或下次进入流水线列表时,该流水线会在流水线列表中置顶显示,收藏多条流水线会按流水线最后一次执行时间降序排列,若未执行过,则按创建时间降序排列。 单击,可编辑流水线、复制流水线、预览流水线、查看流水线操作历史(记录新建记录、编辑记录以及触发失败记录)、为流水线设置标签、禁用流水线、删除流水线。 流水线任务列表默认所有用户均可以查看。 单击“全部流水线”的下拉框,可以根据“全部流水线”、“我新建的”及“最后一次记录由我执行的”进行过滤。 支持在搜索栏中输入流水线名称关键字进行搜索。 单击右上方,可根据需要自定义设置流水线列表信息。 单击流水线名称,进入流水线“执行历史”页面,展示流水线执行记录。 单击时间筛选器,可以选择时间段进行过滤,支持查看最近90天执行记录,默认展示最近31天的执行记录,支持最近7天、14天、31天、90天快捷切换。 首次执行时执行历史页面为空,执行一次后才有记录。 单击执行编号,进入“流水线详情”页面,查看对应执行记录详情。 表1 流水线详情页操作 操作项 说明 重试 如果任务执行失败,单击页面右上角“重试”,可从失败处继续执行流水线。 编辑 单击“编辑”,可修改流水线配置信息。 执行 单击“执行”,可以以最新的配置重新执行流水线,并生成一条新的执行纪录。 下载 单击页面上方产出信息,可下载通过流水线自动构建出来的构建包。 说明: 只有构建类型的任务才有构建包。 存在多个构建包时,单击“全部下载”,可以下载全部构建包。 只展示最新构建的10个包,如需下载其他构建包,请切换到发布库页面自行下载。 查看日志 单击任务卡片,可查看对应任务的任务日志和任务结果。 说明: “延时执行”和“挂起流水线”任务没有日志。 更多操作 单击页面右上角,可复制流水线、查看流水线操作历史、预览流水线、禁用流水线、删除流水线。 说明: 默认只有项目经理或创建者(项目创建者和流水线创建者)才可以删除流水线,可通过配置权限给不同角色添加不同操作权限。 切换到“排队列表”页,可查看流水线排队记录。 如果流水线配置了并发策略,且超过并发后执行策略为排队等待,在该页面可以查看排队等待执行的记录。 单条流水线最多支持100条排队记录。 单条排队记录排队时长超过24小时后会被放弃执行。 单击操作列,可手动取消排队记录,即放弃执行。 排队记录执行时,配置信息以入队时为准。
  • 流水线参数使用示例 本文以通过流水线统一配置releaseversion参数并传递到构建任务为例,介绍流水线参数使用方法。 新建构建任务。 在“参数设置”页面添加releaseversion参数并设置好默认值,打开“运行时设置”。 图3 新建构建任务参数 在“构建步骤”页面,选择“上传软件包到软件发布库”,将“发布版本号”配置成引用参数形式。在参数输入框输入“$”符号后会自动出现参数列表,选择上一步已经新建好的releaseversion参数。 图4 引用构建任务参数 使用“$”符号引用通用参数组的参数时不会自动生成提示。 配置完成后,保存构建任务。 新建空白模板流水线,在流水线阶段添加一个新的任务,然后在该任务中添加“Build构建”插件并调用刚创建的构建任务,即可看到刚新建好的构建任务参数releaseversion。 图5 配置构建任务参数 将鼠标移动到releaseversion参数上,可以一键将该参数设置为流水线参数并能直接引用该参数;或直接单击“确定”,然后切换到流水线“参数设置”页面,新建流水线参数releaseversion,类型可以根据需求选择自增长或字符串等,设置默认值并打开运行时设置。 图6 新建流水线参数 再切回到流水线“任务编排”页面,编辑刚添加的构建任务,将流水线的releaseversion参数通过“$”符号引用到构建任务的releaseversion参数内。 图7 引用流水线参数 该处只显示构建任务中开启“运行时设置”的文本类型参数。 鼠标移至参数名称,可以快速将该参数设置为流水线参数并能直接引用该参数。 完成参数引用后,保存信息,然后单击“保存并执行”,弹出“执行配置”侧滑框,可查看“运行参数配置”。 运行时参数值默认为添加参数时为参数设置的默认值,可根据需要进行修改。流水线运行时在构建任务内使用的就是此时输入的参数值。 设置完参数,单击“执行”,开始使用配置的参数执行流水线。
  • 配置流水线自定义参数 介绍流水线自定义参数新建和配置。 访问CodeArts Pipeline首页。 在流水线列表页搜索目标流水线,单击操作列,选择“编辑”。 进入流水线“任务编排”页面,切换至“参数设置”页面。 单击参数列表下的“立即新建”(已存在自定义参数,则单击“新建参数”),填写参数信息。 表2 流水线自定义参数说明 参数信息 说明 名称 自定义参数名称。支持大小写英文字母、数字、“_”,长度不超过128个字符。 说明: 自定义参数名称不可与系统预定义参数名称相同。 类型 参数可选类型:字符串(默认类型)、自增长、枚举。 默认值 自定义参数的默认取值。 字符串:长度不超过8192个字符。 自增长:长度不超过8192个字符。 说明: 自增长类型参数如果被引用,全新执行一次后,下次执行时参数值末位如果是数字则会自动+1。 枚举:仅支持中文、大小写英文字母、数字、“-”、“_”、“,”、“.”、“/”,长度不超过8192个字符。 选择枚举类型后,在弹出的对话框中添加可选取值,添加完成后在“默认值”下拉框中选择一个默认值,再次单击“枚举”类型,可修改可选取值。 私密参数 参数为私密参数时,系统会将输入参数做加密存储,使用时解密,同时在运行日志里不可见。 运行时设置 打开“运行时设置”开关,在执行流水线时支持修改该参数的值。 参数描述 不超过512个字符。 最多可以新建100个自定义参数。 单击“操作”列,可以新增参数;单击“操作”列,可以删除参数。 配置完成后,保存流水线。
  • 流水线系统预定义参数 表1 流水线系统预定义参数 参数信息 说明 TIMESTAMP 流水线执行时间戳。例如:20211222124301。 PIPELINE_TRIGGER_TYPE 流水线触发类型。包括:Manual、Scheduler、RollBack以及WebHook类型(CreateTag、Note、Issue、MR、Push)。 PIPELINE_NAME 流水线名称。 REPO_URL 代码仓地址(HTTPS)。 EXECUTE_USER 执行人。 PASS_CONDITIONS_LINK 流水线执行详情链接。 PIPELINE_RUN_ID 流水线执行ID。 MERGE_ID 合并请求ID。 WEBHOOK_PAYLOAD Webhook请求负载信息。 Repo01_REPOSITORY_NAME 仓库名称。 Repo01_SOURCE_BRANCH 仓库运行源分支名称。 Repo01_TARGET_BRANCH 仓库运行目标分支名称。 Repo01_TAG 仓库标签名称。 Repo01_COMMIT_ID 执行时代码最后一次提交的ID。 Repo01_COMMIT_ID_SHORT 执行时代码最后一次提交的短ID Repo01_REPO_URL 代码仓地址(HTTPS)。
  • YAML语法规范 快速上手语法示例 流水线串联编译构建任务、代码检查任务、部署任务,并在编译构建任务中引用流水线参数。 env: # 以键值对的形式定义环境变量,定义后可在流水线的任意任务中引用 image_version: 1.0.0 jobs: # 定义组成流水线的任务 build: # 任务ID,定义任务的唯一标识 name: maven build # 任务的名称,在图形化界面中会展示该名称 steps: # 定义组成任务的步骤 - name: My build step # 步骤的名称,在图形化界面中会展示该名称 uses: CodeArtsBuild # 指定步骤运行的插件 with: # 以键值对的形式定义插件的运行参数,可引用env中定义的变量。 jobId: 878b4d13cb284d9e8f33f988a902f57c # 进入对应任务页面,获取浏览器地址后面的随机数字,即当前任务的jobId artifactIdentifier: my_image version: ${{ env.image_version }} check: name: code check steps: - name: My check step uses: CodeArtsCheck with: jobId: 43885d46e13d4bf583d3a648e9b39d1e checkMode: full deploy: name: cce deploy needs: # 使任务在指定的任务结束后才开始运行 - build - check if: ${{ completed() }} # 指定任务的运行条件 steps: - name: My deploy step uses: CodeArtsDeploy with: jobId: 9c5a5cda6ffa4ab583380f5a014b2b31 version: ${{ env.image_version }}
  • 代码化新建流水线 访问CodeArts Pipeline首页。 单击“新建流水线”,进入“基本信息”页面,参考表1配置流水线基本信息。 表1 流水线基本信息参数说明 参数项 说明 名称 流水线的名称,自定义。支持中文、大小写英文字母、数字、“-”、“_”,长度不超过128个字符。 所属项目 流水线归属项目。 从流水线服务首页入口新建流水线,请根据实际需要选择已创建的项目。 从项目下流水线入口新建流水线,所属项目默认为当前项目,不可更改。 代码源 选择“Repo”:即CodeArts Repo,提供企业代码托管的全方位服务,为软件开发者提供基于Git的在线 代码托管服务 。 说明: 代码化流水线仅支持使用CodeArts Repo代码仓。 创建方式 选择“YAML化编排”:以代码化YAML方式编排流水线,支持语法自动补齐和校验,方便多流水线批量配置。 代码仓 流水线关联的代码仓库。 默认分支 仓库默认分支,手工或定时执行流水线时默认使用的分支。 配置方式 新建yaml文件:创建一个新的YAML文件。 已有yaml文件:基于已有YAML文件进行编排,编排后的内容会覆盖原YAML文件。YAML文件编写请参考YAML语法规范。 选择yaml文件 配置方式选择“已有yaml文件”时,需设置此参数。 选择提前准备好并存储在代码仓库的YAML文件:选择对应分支并输入YAML文件的相对路径。 Repo HTTPS授权 配置授权扩展点以提升代码库操作权限,当前主要用于流水线服务的微服务变更功能模块及其相关插件。可选择准备工作中提前创建的扩展点,也可单击“新建授权”进行创建,具体操作请参考新建CodeArts服务扩展点。 别名 仓库别名,设置别名后可基于别名生成仓库对应的系统参数,如:“别名_REPOSITORY_NAME”,表示仓库名称。生成的参数可在参数设置页面查看,并在流水线中通过“${参数名}”进行引用。 描述 不超过1024个字符。 配置完基本信息,单击“确定”,进入“任务编排”页面。 左侧为YAML编辑区域,请参考YAML语法规范编写YAML。 右侧为流水线插件列表,请根据需要添加步骤yaml。 编排过程支持语法规范校验;单击“预览”,可切换至图形化界面预览效果。 编排完任务,单击“保存”,填写提交信息,选择推送分支。 选项一表示推送到已有分支:如果是“新建yaml文件”方式新建流水线,已有分支为默认分支;如果是基于“已有yaml文件”方式新建流水线,已有分支则为YAML文件所在的分支。 选项二表示推送到新分支:基于上述已有分支创建一个新分支,勾选“创建合并请求”,则会创建一个从新分支到已有分支的合并请求。 单击“确定”,完成流水线创建。
  • 步骤4:执行变更流水线 代码更新完成后,即可通过变更流水线执行变更。 在微服务变更列表页面,单击变更名称,进入“变更详情”页面。 单击右上角“提交发布”,弹出“提交发布”确认框,提示是否确认将变更提交至变更流水线。 图1 提交发布 单击“确定”,完成变更提交,页面跳转至对应变更流水线发布列表页面。 单击右上角“执行”,弹出“执行配置”侧滑框,选择刚提交的变更,其他配置保持默认。 图2 执行配置 单击“执行”,启动变更流程。 微服务变更流水线在运行过程中,会自动增加“合并集成分支”和“合并主干”阶段,并将本次变更关联的特性分支合并到该集成分支上。 代码检查、构建任务执行成功后,系统自动进入“合并主干”阶段,并弹出“手动确认”对话框。 图3 执行流水线 单击“继续执行”,“合并主干”阶段执行完成后,系统将自动完成以下事项。 将本次发布的变更状态更新为“已发布”。 将本次发布的变更关联的工作项状态更新为“已关闭”。 将本次发布使用的集成分支代码内容合并到微服务默认分支,实现代码自动合并。 至此,即完成了一次基本的微服务变更发布流程。
  • 方案概述 CodeArts Pipeline为企业提供了一种微服务模型,将企业大军团的作战方式转变为小团队精英作战方式,支持每个微服务独立进行开发、验证、部署及上线发布,缩短需求发布周期。同时支持企业按照业务功能组织团队,优化管理模型,使运作更精细化,有效提升团队运作效率。 在微服务中,用户可以创建流水线资源,并将其设置为变更流水线,用于与微服务下变更资源进行联动,通过变更流水线发布一个或多个变更来实现项目的快速交付。
  • 步骤2:新建变更流水线 在微服务列表页面,单击微服务名称,进入微服务“概览”页面。 切换到“流水线”页签,进入微服务流水线列表页面。 单击“新建流水线”,进入“新建流水线 ”页面,配置以下信息。 表3 新建变更流水线 参数项 说明 所属项目 变更流水线所在的项目,不可更改。 名称 变更流水线的名称,使用自动生成的即可。 代码源 变更流水线关联的源码类型,自动和微服务保持一致。 代码仓 变更流水线关联的源码仓库,自动和微服务保持一致。 默认分支 默认使用的分支,自动和微服务保持一致。 Repo https授权 打开“基于变更触发”后需配置“Repo HTTPS授权”,配置授权扩展点以提升代码仓操作权限。选择准备工作中已创建的授权扩展点“HttpsEndpoint01”。 别名 输入别名,会生成该仓库对应的相关系统参数,这里不设置。 基于变更触发 打开“基于变更触发”,将当前流水线设置为微服务变更流水线。 描述 对变更流水线的介绍说明,选填。 微服务变更流水线仅支持基于变更触发运行,且单个微服务下只能存在一条微服务变更流水线。 单击“下一步”,选择“Maven构建”模板,自动生成阶段和任务,使用默认配置即可。 单击“保存”,完成微服务变更流水线的创建。
  • 步骤3:新建微服务变更 重新进入微服务“概览”页面。 切换到“变更”页签,进入微服务变更列表页面。 单击“新建变更”,进入“新建变更 ”页面,配置以下信息。 表4 新建变更 参数项 说明 变更标题 变更的名称,输入“fix-a-bug”。 代码仓 变更关联的源码仓库,自动和微服务保持一致。 代码分支 变更新需求的开发分支,变更通过流水线发布成功后,会将代码分支自动合并至微服务的默认分支。选择“从默认分支拉取新分支”并输入分支名称“bugfix”。 关联工作项 变更关联的工作项,选择准备工作中已创建的工作项“BUGFIX”。 单击“确定”,完成变更的创建。 变更创建完成后,进入代码开发阶段,系统基于微服务默认分支自动创建出本次变更的特性分支,开发人员可以基于该特性分支进行代码开发,问题修复后,模拟向该分支提交代码。
  • 操作流程 本文介绍如何通过微服务变更流水线模拟修复项目下的一个BUG并快速发布,基本操作流程如下: 步骤1:新建流水线微服务 步骤2:新建变更流水线 步骤3:新建微服务变更 步骤4:执行变更流水线 表1 操作流程说明 流程 说明 新建流水线微服务 在项目下新建一个微服务,用于管理某个特定的业务功能。 新建变更流水线 在微服务下新建一条变更流水线,用于发布微服务下的变更。 新建微服务变更 在微服务下新建一个变更,承载项目下修复BUG的开发活动。 执行变更流水线 执行流水线,发布变更代码。
  • 操作流程 本文以版本号参数为例,介绍如何将流水线参数传递给编译构建任务和部署应用,基本操作流程如下: 步骤1:新建编译构建任务 步骤2:新建部署应用 步骤3:新建并执行流水线 步骤4:查看编译构建和部署结果 表1 操作流程说明 流程 说明 新编译构建任务 新建编译构建任务,新增版本号参数,并在构建步骤引用该参数。 新建部署应用 新建部署任务,新增软件包参数,并在部署步骤引用该参数。 新建并执行流水线 新建流水线,新增版本号参数,并在流水线上添加编译构建任务及部署应用。 在编译构建任务的版本号参数引用流水线版本号参数。 在部署应用软件包参数引用流水线版本号参数。 查看编译构建和部署结果 分别查看编译构建结果和部署结果。 编译构建包版本号为流水线传递的动态参数。 部署任务成功获取软件包。
  • 操作流程 本文基于流水线准出条件-Check代码检查规则策略,通过添加代码检查任务所在阶段的准出条件,对代码检查任务的检查结果进行自动化校验,只有检查结果满足准出条件,才可以进入下一个阶段。 图1 操作流程示意图 基本操作流程如下: 步骤1:新建规则并配置阈值 步骤2:新建策略并添加规则 步骤3:配置流水线 步骤4:执行流水线验证准出条件 表1 操作流程说明 流程 说明 新建规则并配置阈值 新建一个代码检查类型规则,基于代码检查插件的输出结果,设置比较关系和阈值条件,供策略使用,作为准出条件的判断依据。 新建策略并添加规则 新建一个策略,并添加如上代码检查类型规则。 配置流水线 在流水线阶段准出条件添加如上策略,根据设置的规则条件,来控制流水线执行。 执行流水线验证准出条件 执行流水线,验证准出条件拦截结果。 代码检查插件满足规则条件,通过准出条件校验,流水线继续执行。 代码检查插件如果不满足规则条件,没有通过准出条件校验,流水线终止执行。
  • 准备工作 新建项目(选择“Scrum”模板,命名为“Project01”)。 新建代码仓库(选择“Java Maven Demo”模板,命名为“Repo01”)。 新建代码仓库时会自动创建与代码仓库同名的代码检查任务,将代码检查任务名称修改为“CheckTask01”,操作方法请参考创建代码检查任务。 基于“Repo01”仓库新建构建任务(选择“Maven”模板,命名为“BuildTask01”)。 基于已创建的代码仓库新建流水线(选择空模板,命名为“Pipeline01”)。
  • 步骤2:新建策略并添加规则 策略实行分层管理,可分为租户级策略和项目级策略。其中,租户级策略可以应用到当前租户下所有项目的流水线,项目级策略可以应用到当前项目下所有流水线。本节以租户级策略为例进行介绍。 单击左侧导航栏“策略”,进入策略管理页面。 租户级策略中默认存在一条“系统策略”,用户可查看和使用该策略,但不能进行编辑和删除。 单击“新建策略”,进入“新建策略”页面,输入策略名称,勾选步骤1中新建好的规则。 图3 新建策略 单击“确定”,完成策略创建。