- 最新动态
- 功能总览
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 模板管理
-
流水线管理
- 启动流水线
- 批量获取流水线状态
- 获取流水线状态/获取流水线执行详情
- 获取流水线列表/获取项目下流水线执行状况
- 删除流水线
- 查询流水线详情
- 修改流水线信息
- 停止流水线
- 获取流水线执行记录
- 基于模板创建流水线
- 创建流水线
- 重试运行流水线
- 通过人工审核
- 获取流水线运行需要的自定义参数
- 驳回人工审核
- 查询流水线日志
- 获取流水线步骤执行输出
- 查询流水线上的构建产物
- 批量删除流水线
- 禁用流水线
- 批量设置流水线标签
- 启用流水线
- 批量运行流水线
- 查询流水线任务日志
- 延时任务通过
- 延时任务拒绝
- 延时1小时
- 手动卡点通过
- 手动卡点拒绝
- 解除挂起
- 查询批量执行流水线结果
- 交换分组顺序
- 流水线官方消息通知查询
- 流水线官方消息通知更新
- 流水线消息通知开关
- 流水线第三方消息通知查询
- 流水线第三方消息通知更新
- 查询流水线的角色权限
- 查询流水线的用户权限
- 修改流水线的角色权限
- 修改流水线的用户权限
- 查询流水线是否启用二级权限
- 修改流水线是否启用二级权限
- 批量设置流水线实例二级权限
- 取消某次流水线排队
- 查询当前流水线排队中的记录
- 查询流水线的旧版运行记录
- 查询流水线运行使用的参数
- 回退执行流水线
- 获取step跳转链接
- 查询流水线运行的变更
- 查询流水线可用的系统参数
- 查询流水线触发失败记录
- 查询流水线修改历史
- 创建参数组
- 修改参数组
- 删除参数组
- 流水线绑定参数组
- 查询参数组详情
- 查询流水线关联的参数组
- 查询参数组列表
- 获取通用Webhook信息
- 分组管理
- 规则管理
- 租户级策略管理
- 项目级策略管理
- 扩展插件管理
- 扩展点管理
- 流水线标签管理
- 变更管理
- 微服务管理
- 模板管理（旧版，待下线）
- 流水线管理（旧版，待下线）
- 应用示例
- 附录
- 文档修订记录
- 场景代码示例
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
配置流水线执行计划
流水线支持配置事件触发、定时任务、Webhook触发和并发策略四种执行计划。通过事件触发和定时任务，实现自动化执行；通过Webhook触发，用户可以通过任意第三方系统触发流水线执行；通过并发策略，可以更细粒度地为用户分配并发资源。
配置流水线事件触发
事件触发包括代码提交时触发、合并请求时触发、创建标签时触发。码云代码仓还支持Pull Request、新建issue、评论issue等其他事件。
- 访问CodeArts Pipeline首页。
- 在流水线列表页搜索目标流水线，单击操作列
，选择“编辑”。 - 进入流水线“任务编排”页面，切换至“执行计划”页面，在“事件触发”勾选触发事件进行配置。
- 代码提交时触发（代码托管/码云）
监听代码提交触发事件，可以组合分支和具体路径的包含/排除范围，当在关联的代码仓库中有代码提交且所在的分支和变更文件的路径满足包含/排除策略，会自动触发关联流水线执行。
- 分支过滤：可以通过设置包含或排除分支，来监听触发事件所在的目标分支。
- 路径过滤：可以通过设置包含或排除路径，来监听触发事件所在的变更文件路径。
图1 配置代码提交时触发
- 合并请求时触发（代码托管/码云）
监听合并请求触发事件，可以组合分支和具体路径的包含/排除范围，对新建、合并、更新和重新打开事件设置触发策略，当在关联的代码仓库中触发合并请求事件且分支满足包含/排除策略，会自动触发关联流水线执行。
事件说明：
- 新建：合并请求创建时触发。
- 合并：合并请求合入时触发，该事件会同时触发代码提交事件。
- 重新打开：合并请求重新打开时触发。
- 更新：合并请求内容更新、设置更新或者源代码更新时触发，打开“仅代码更新触发”，则仅源代码更新时触发。
分支说明：
- 分支过滤：可以通过设置包含或排除分支，来监听触发事件所在的目标分支。
- 路径过滤：可以通过设置包含或排除路径，来监听触发事件所在的变更文件路径。
图2 配置合并请求时触发
- 创建标签时触发（代码托管）
监听创建标签触发事件，可以设置标签包含/排除范围，当在关联的代码仓库创建标签且满足标签包含/排除策略，会自动触发关联流水线执行。
图3 配置创建标签时触发
- 其他事件（码云）
- 评论Pull Request：评论Pull Request时触发流水线执行。
- 新建issue：新建issue时触发流水线运行。
- 评论issue：评论issue时触发流水线运行。
说明：
- 除了上述事件外，码云代码仓还支持开启事件触发成功后自动评论。
- 先匹配分支，再匹配路径，都匹配成功，则触发流水线。
- 路径排除优先于路径包含，即先匹配排除的路径，如果变更文件没有全部在排除范围内，则继续匹配包含的路径。若未配置包含路径，则匹配成功，触发流水线；若配置了包含路径，并且变更文件在路径排除范围外有任意一个在包含范围内，则匹配成功，触发流水线。
- 标签排除优先于标签包含，即标签同时在包含和排除中时，则匹配失败，不触发流水线。
- 路径匹配范围：单次提交的前300个变更文件，变更文件数超过300建议拆分。
- 代码提交时触发（代码托管/码云）
- 配置完成后，保存流水线。
配置流水线定时执行
配置流水线在指定的时间自动执行。
- 访问CodeArts Pipeline首页。
- 在流水线列表页搜索目标流水线，单击操作列
，选择“编辑”。 - 进入流水线“任务编排”页面，切换至“执行计划”页面。
- 单击“定时任务”区域的“创建定时任务”，增加一个定时任务，打开“启用定时执行”开关（默认开启），配置如下信息：
图4 配置定时任务
表1 定时任务 参数项
说明
执行日
选择执行日期。
时间段
选择执行时间段和时区。
间隔时间
设置间隔时间，即每间隔多长时间触发一次。
说明：
- 最多可以设置10个定时任务。
- 单击右上角
，可删除定时任务；单击右上角
，可复制定时任务。
- 配置完成后，保存流水线。
Webhook触发
通过Webhook触发，用户可以通过任意第三方系统触发流水线执行。
- 访问CodeArts Pipeline首页。
- 在流水线列表页搜索目标流水线，单击操作列
，选择“编辑”。 - 进入流水线“任务编排”页面，切换至“执行计划”页面。
- 打开“Webhook”开关（默认关闭），参数说明如表2，保存流水线后即可生效。
图5 配置Webhook触发
表2 配置Webhook触发 参数项
说明
Webhook触发源
将该地址复制到第三方系统触发器，使用Post方法调用，即可运行流水线。
IAM认证
- 启用IAM认证，需要将用户IAM Token加入接口请求头，调用示例如下：
curl --header "Content-Type: application/json" --header 'x-auth-token: XXXX（IAM Token）' --request POST --data "{}" Webhook触发源 - 不启用IAM认证，调用示例如下：
curl --header "Content-Type: application/json" --request POST --data "{}" Webhook触发源
- 启用IAM认证，需要将用户IAM Token加入接口请求头，调用示例如下：
配置流水线并发策略
默认单条流水线最大执行并发数为5，超过并发数后新的触发忽略不执行。可以通过并发策略为单条流水线配置同时处于运行中和暂停状态的流水线最大实例个数，即并发数，更细粒度地为用户分配并发资源。
- 访问CodeArts Pipeline首页。
- 在流水线列表页搜索目标流水线，单击操作列
，选择“编辑”。 - 进入流水线“任务编排”页面，切换至“执行计划”页面。
- 打开“并发策略”开关（默认关闭），设置并发数和超过并发后执行策略。
图6 配置并发策略
表3 配置并发策略 参数项
说明
并发个数
单条流水线最大执行并发数，受套餐和购买并发数限制。
超过并发后执行策略
超过并发数后可选择如下两种处理方式：
- 排队等待：超过并发数后新的触发排队等待执行，可进入流水线详情页查看排队记录。
- 单条流水线最多支持100条排队记录。
- 单条排队记录排队时长超过24小时后会被放弃执行。
- 排队记录支持手动取消排队，即放弃执行。
- 排队记录执行时，配置信息以入队时为准。
- 忽略不执行：超过并发数后新的触发忽略不执行。
- 排队等待：超过并发数后新的触发排队等待执行，可进入流水线详情页查看排队记录。
- 配置完成后，保存流水线。
配置流水线抢占策略
同一条流水线存在多个运行实例时，新触发的运行实例会强行停止当前流水线中相同事件触发的其他所有运行实例。
- 访问CodeArts Pipeline首页。
- 在流水线列表页搜索目标流水线，单击操作列
，选择“编辑”。 - 进入流水线“任务编排”页面，切换至“执行计划”页面。
- 打开“抢占策略”开关，选择抢占事件，保存流水线后即可生效。
图7 配置抢占策略
- 抢占策略当前只支持CodeArts Repo流水线源。
- 当前仅支持“MR ID”抢占事件，即抢占由同一个MR触发的流水线运行实例。
- 抢占事件触发后，将会停止当前流水线中满足抢占条件的所有运行中的流水线实例。
- 若当前流水线超并发，且不存在满足抢占条件的运行实例，则此次执行请求会被忽略。
