检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
入门实践 当您完成创建项目、代码仓库等准备工作后,可以根据业务需求使用流水线提供的一系列常用实践。 表1 常用最佳实践 实践 描述 通过微服务变更流水线修复项目BUG并快速发布 CodeArts Pipeline为企业提供了一种微服务模型,将企业大军团的作战方式转变为小团队精英作战方式
查询流水线修改历史 功能介绍 查询流水线修改历史 调用方法 请参见如何调用API。 URI GET /v5/{project_id}/api/pipelines/{pipeline_id}/pipelines-modify-historys 表1 路径参数 参数 是否必选 参数类型
身份认证与访问控制 身份认证 用户访问流水线的方式有多种,包括流水线用户界面、API,无论访问方式封装成何种形式,其本质都是通过流水线提供的REST风格的API接口进行请求。 流水线的接口需要经过认证请求后才可以访问成功。流水线支持两种认证方式: Token认证:通过Token认证调用请求
基本概念 表1 流水线服务基本概念 词汇 定义 任务编排 用户基于生产交付业务流编排流水线阶段和任务,通常是在流水线新建、复制和编辑操作场景下进行定义。 阶段 阶段是流水线上的基本组成部分,主要用于对流水线纳管的“构建”、“代码检查”、“接口测试”、“部署”等执行任务做业务流程上的分类编排管理
批量设置流水线标签 功能介绍 批量设置流水线标签 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/api/pipeline-tag/set-tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释
执行流水线 流水线支持一键执行,执行过程可视化,可实时查看执行进度、日志、结果等信息,提供健康度分析。 执行流水线 访问CodeArts Pipeline首页。 在流水线列表页找到待执行的流水线,单击操作列。 弹出“执行配置”对话框,配置如下信息: 流水线源:选择代码源的分支或标签
手动卡点拒绝 功能介绍 手动卡点拒绝 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/steps/{stepRunId}/manual
执行镜像命令 通过“执行镜像命令”插件,可以将用户在SWR上的公开镜像下载到自定义执行机并启动。 约束与限制 “执行镜像命令”插件只支持自定义执行机。 配置方法 在编排流水线任务时,添加“执行镜像命令”插件。 图1 执行镜像命令 根据需要配置任务参数,参数说明如下: 参数项 说明
查询批量执行流水线结果 功能介绍 查询批量执行流水线结果 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/api/pipelines/batch-runs/result 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
检查流水线创建状态 功能介绍 检查流水线创建状态 调用方法 请参见如何调用API。 URI GET /v3/templates/{task_id}/status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 实例ID 请求参数 表2 请求Header
手动卡点通过 功能介绍 手动卡点通过 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/steps/{step_run_id}
流水线官方插件 流水线当前内置的官方插件如表1。 表1 流水线官方插件 插件类型 插件名 插件使用介绍 构建 Build构建 调用编译构建能力进行构建。编译构建服务为开发者提供配置简单的混合语言构建平台,实现编译构建云端化,支撑企业实现持续交付,缩短交付周期,提升交付效率。支持编译构建任务一键创建
流水线触发方式on 使用on关键字可指定流水线的自动触发方式。可以在on中指定多个代码事件触发流水线的方式,支持通过过滤规则实现仅当满足特定的分支、文件、标签变更时才触发流水线;也可以在on中指定定时任务执行流水线。 on.<event_name>.types 指定触发流水线的代码事件的具体类型
收藏流水线模板 功能介绍 收藏流水线模板 调用方法 请参见如何调用API。 URI POST /v5/{tenant_id}/api/pipeline-templates/{templateId}/favorite 表1 路径参数 参数 是否必选 参数类型 描述 tenant_id
查询标签列表 功能介绍 查询标签列表 调用方法 请参见如何调用API。 URI GET /v5/{project_id}/api/pipeline-tag/list 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: CodeArts
查询项目下变更创建人信息 功能介绍 查询项目下变更创建人信息 调用方法 请参见如何调用API。 URI GET /v2/{cloudProjectId}/change-request/creator/list/search 表1 路径参数 参数 是否必选 参数类型 描述 cloudProjectId
创建参数组 功能介绍 创建参数组 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/api/pipeline/variable/group/create 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释
流水线插件概述 流水线内置了一系列常用的插件,覆盖构建、检查、部署、测试全领域,供用户在流水线编排时使用。同时提供一套标准的扩展插件接入方式,支持企业将已有工具链接入插件平台,或者基于自身业务需求快速开发、发布插件,并在企业内进行共享和复用,加速企业上云。通过打造可视化、低代码、开放的插件市场
通过云原生发布插件进行发布 发布管理环境依赖流水线云原生发布插件进行发布,云原生发布插件主要作用是触发对应环境的发布策略,依照发布策略完成环境的发布。 通过云原生发布插件进行发布 配置流水线。 在流水线阶段新建任务, 添加“云原生发布”插件,参数说明如表1。 云原生发布提供环境级别的服务发布能力
文档修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第三十九次正式发布,本次变更说明如下: 新增流水线管理相关接口。 新增扩展点管理相关接口。 启动流水线接口删除请求参数event_type。 2024-12-05