codearts-extension.json文件定义 codearts-extension.json文件示例： { "type": "Task", "name": "demo_plugin", "friendlyName": "示例插件", "description": "这是一个示例插件", "category": "Gate", "version": "0.0.2", "versionDescription": "0.0.1初始化版本", "dataSourceBindings": [], "inputs": [ { "name": "samplestring", # 如插件业务脚本中使用${samplestring}获取运行者在流水线上配置的值 "type": "input", # 不同类型信息对应不同展示功能，可选项见下文 "description": "Sample String", # input条目的描述信息，用于描述其值含义 "defaultValue": "00", # 默认值，required属性为false时，如不在流水线上重新输入，则默认使用此值 "required": true, # true则流水线编辑时必须重新填值，false则不填使用默认值 "label": "测试输入框", # input条目在流水线编辑页面显示的名称信息 "validation": { "requiredMessage": "请输入值", # (可选) 如required字段为true，未填写时的提示信息 "regex": "^[a-zA-Z0-9-_\\u4e00-\\u9fa5]{1,32}$", #(可选)可填写正则校验的内容 "regexMessage": "类型错误" # (可选) 如正则校验失败的提示信息 } } ], "execution": { "type": "Shell", "target": "scripts/execution.sh" }, "outputs": [{ "name": "okey", # 输出名称 "type": "output", # 输出类型，output/metrics "description": "描述", "prop": { "defaultValue": "123" # 默认值 } }, { "name": "mkey", "type": "metrics", "description": "描述", "prop": { "defaultValue": "213", "group": "213" # 对应准出规则中的分组名称 } } ] } codearts-extension.json文件参数说明如下： 表2 codearts-extension.json文件参数说明 参数项 说明 type 填写固定值“Task”，标识为一个插件类型。 name 请与注册插件时页面填写的基本信息“唯一标识”字段一致。 friendlyName 请与注册插件时页面填写的基本信息“插件名称”字段一致。 category 请与注册插件时页面填写的基本信息“插件类型”字段一致，包括以下可选值： Build：对应“构建”插件类型。 Test：对应“测试”插件类型。 Gate：对应“代码检查”插件类型。 Normal：对应“通用”插件类型。 Deploy：对应“部署”插件类型。 version 插件版本，支持填写3组0-99的数字，如需新增正式版本，请修改此字段。 description 插件的描述信息。 versionDescription 此版本插件的描述信息，建议体现每个版本的差异点。 dataSourceBindings 此字段暂时未启用，请将值设置为“[]”。 inputs 插件输入内容，对应流水线页面插件展示格式，其值可在业务脚本中通过引用环境变量的方式引用。 execution 业务插件执行内容，其中type字段为业务脚本语言类型，target字段为执行文件入口，建议放在scripts文件夹下。 outputs 插件输出内容，在插件运行结束后写入此处定义值，可对应用作门禁指标metrics，不同的展示结果output。

准备自定义插件包 插件包结构 图1 插件包结构 文件结构 extension.zip # 插件zip包 | -- scripts # （可选）脚本文件夹，用于存放包含插件执行逻辑的脚本 | | -- xxx # 包含插件执行逻辑的脚本 | -- i18n # （可选）多语言，存放所有文案信息 | | -- zh-cn # 中文环境内容 | | -- resource.json # 对应语言的国际化资源 | | -- en-us # 英文环境内容 | | -- resources.json # 对应语言的国际化资源 | -- codearts-extension.json # （必选）插件执行定义文件，Json格式，包括扩展插件的基本信息+input+execution 注意事项 插件包必须为.zip后缀。 插件包根目录下必须包含元数据文件codearts-extension.json，codearts-extension.json文件介绍请参考codearts-extension.json文件定义。 resources.json文件只能使用utf-8进行编码，不支持中文标点符号与其他编码形式，若输入则为乱码展示。

方案概述 通过配置代码仓与流水线，实现对合并请求的自动化门禁，提升代码质量和团队协作效率。通过设置合并请求触发流水线，确保每个合并请求在创建或更新时自动执行代码检查、构建和测试任务，只有经过严格代码审查的代码才能合并到主分支。这种机制可以有效减少因代码缺陷而导致的生产环境问题，保证代码的稳定性和可靠性，从而强化代码的质量控制。整体而言，该方案为团队提供了一种高效且可靠的工作流程，促进了持续集成与持续交付的最佳实践。

审计与日志 审计 云审计 服务（Cloud Trace Service， CTS ），是华为 云安全 解决方案中专业的日志审计服务，提供对各种云资源操作记录的收集、存储和查询功能，可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 用户开通云审计服务并创建和配置追踪器后，CTS可记录流水线的管理事件和数据事件用于审计。 CTS的详细介绍和开通配置方法，请参见CTS快速入门。 CTS支持追踪的流水线操作列表，请参见云审计服务支持的操作列表。 日志 出于分析或审计等目的，用户开启了云审计服务后，系统开始记录流水线资源的操作。云审计服务管理控制台保存最近7天的操作记录。 父主题： 安全

数据保护技术 流水线通过多种数据保护手段和特性，保证通过流水线的数据安全可靠。 表1 流水线的数据保护手段和特性 数据保护手段 简要说明 详细介绍 传输加密（HTTPS） 流水线所有API均采用HTTPS传输协议。 构造请求 个人数据保护 流水线通过控制个人数据访问权限以及记录操作日志等方法防止个人数据泄露，保证您的个人数据安全。 云审计服务支持的操作列表 隐私数据保护 涉及到用户的数据库账号信息需要存储时，提供敏感 数据加密 存储。 - 数据备份 支持用户数据备份。 - 父主题： 安全

身份认证与访问控制 身份认证 用户访问流水线的方式有多种，包括流水线用户界面、API，无论访问方式封装成何种形式，其本质都是通过流水线提供的REST风格的API接口进行请求。 流水线的接口需要经过认证请求后才可以访问成功。流水线支持两种认证方式： Token认证：通过Token认证调用请求，访问流水线服务用户界面默认使用Token认证。 AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。推荐使用AK/SK认证，其安全性比Token认证要高。请参见AK/SK鉴权。关于认证鉴权的详细介绍及获取方式，请参见认证鉴权。 访问控制 流水线支持通过权限控制（ IAM 权限）进行访问控制。 表1 流水线访问控制 访问控制方式 简要说明 详细介绍 权限控制 IAM权限 IAM权限是作用于云资源的，IAM权限定义了允许和拒绝的访问操作，以此实现云资源权限访问控制。默认情况下，管理员创建的IAM用户没有任何权限，需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限。 IAM产品介绍、流水线权限管理 父主题： 安全

责任共担 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的云安全挑战和无孔不入的云安全威胁与攻击，华为云在遵从法律法规业界标准的基础上，以安全生态圈为护城河，依托华为独有的软硬件优势，构建面向不同区域和行业的完善云服务安全保障体系。 安全性是华为云与您的共同责任，如图1所示。 华为云：负责云服务自身的安全，提供安全的云。华为云的安全责任在于保障其所提供的IaaS、PaaS和SaaS类云服务自身的安全，涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身，也包括运维运营安全，以及更广义的安全合规遵从。 租户：负责云服务内部的安全，安全地使用云。华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类云服务内部的安全以及对租户定制配置进行安全有效的管理，包括但不限于虚拟网络、 虚拟主机 和访客虚拟机的操作系统，虚拟防火墙、API网关和高级安全服务，各项云服务，租户数据，以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮书》详细介绍华为云安全性的构建思路与措施，包括云安全战略、责任共担模型、合规与隐私、安全组织与人员、基础设施安全、租户服务与租户安全、工程安全、运维运营安全、生态安全。 图1 华为云安全责任共担模型 父主题： 安全

规格与限制 表2 流水线使用限制 指标类别 指标项 限制值 流水线服务 单租户下最大流水线条数 5000 最大同时执行并发数 体验版：1 基础版：5 专业版：10 企业版：20 单租户下最大标签数量 100 单项目下最大标签数量 100 单项目下最大通用参数组数量 5 单项目下最大分组数量 100 单租户下最多任务模板数量 5000 单项目下最多任务模板数量 100 单条流水线 最大Stage阶段数量 16 最大Job任务数量 256 单阶段最大Job任务数量 100 最大Step步骤数量 512 单Job最大Step步骤数量 16 最大自定义参数个数 100 最大源码仓库数 1 审核任务最大审核人数 10 延时任务最大延时次数 3 历史执行记录最大保留天数 90 最大配置定时任务个数 10 最大支持监听分支条件数 32 最大支持监听路径条件数 32 表3 发布管理限免版本使用限制 指标类别 指标项 限制值 云原生发布 单项目下最大环境数量 50 单个环境最大策略数量 5 单个策略最大任务数量 10 单个环境最大自定义环境变量个数 50 单个环境最大自定义环境变量可查看历史版本数 20 表4 策略使用限制 指标类别 指标项 限制值 策略管理 单租户下最大自定义规则条数 2000 单租户下所有项目中项目级策略最大总和 1000 单租户下最大自定义策略条数 500 单项目下最大自定义策略条数 100 单策略中最大自定义规则条数 20 表5 微服务使用限制 指标类别 指标项 限制值 微服务 单租户下最大微服务数量 500 单项目下最大微服务数量 50 表6 变更使用限制 指标类别 指标项 限制值 变更 单个微服务下最大进行中的变更数量（即处于开发中、待发布、发布中的变更总数） 50 单个变更关联最大关联工作项数量 10 发布流水线最大运行变更数量 10

命名限制 表1 流水线命名限制 限制项 说明 流水线名称 支持中文、大小写英文字母、数字、“-”、“_”。 长度范围为1~128个字符。 规则名称 支持中文、大小写英文字母、数字、“-”、“_”。 长度范围为1~128个字符。 策略名称 支持中文、大小写英文字母、数字、“-”、“_”。 长度范围为1~128个字符。 自定义插件名称 支持空格、中文、大小写英文字母、数字、“-”、“_”、“.”。 长度范围为1~50个字符。 参数名称 支持大小写英文字母、数字、“_”。 长度范围为1~128个字符。

基本概念 表1 流水线服务基本概念 词汇 定义 任务编排 用户基于生产交付业务流编排流水线阶段和任务，通常是在流水线新建、复制和编辑操作场景下进行定义。 阶段 阶段是流水线上的基本组成部分，主要用于对流水线纳管的“构建”、“代码检查”、“接口测试”、“部署”等执行任务做业务流程上的分类编排管理，方便聚合管理业务关联性强的执行任务，让流水线上的业务流更加直观。 任务 任务是流水线上可管理的最小执行单元，可以在流水线阶段中进行纳管和串并行编排，通常是“构建”、“代码检查”、“接口测试”、“部署”等类型的任务。 执行计划 执行计划用于定义流水线自动触发的一些配置规则和运行规则，通过配置执行计划可以使流水线的自动化运行更加灵活易用。 准出条件 用户在定义流水线时，在阶段中配置的用于进行自动化看护的质量指标卡点，通过配置策略，来实现阶段准出的校验，并最终控制流水线的执行。 流水线模板 用于复用创建流水线的模板。

什么是流水线 流水线（CodeArts Pipeline）提供可视化、可编排的CI/CD持续交付软件生产线，帮助企业快速转型，实现DevOps持续交付高效自动化，缩短应用TTM（Time to Market）交付周期，提升研发效率。 流水线本质上是一个可视化的自动化任务调度平台，需要配合软件开发生产线中编译构建、代码检查、测试计划、部署等服务的自动化任务使用。根据用户需要的场景，如开发测试环境应用部署、生产环境应用部署等，对这些自动化任务进行自定义编排，一次配置后就可以一键自动化触发调度执行，避免频繁低效的手工操作。 流水线是软件开发生产线中的一个服务，不支持单独购买，需配合软件开发生产线其他服务使用，开通任意软件开发生产线套餐即可使用。CodeArts采用包年/包月计费模式，提供体验版、基础版、专业版、企业版四种套餐，以满足不同规模用户的使用需求，购买开通方式请参考购买CodeArts。 流水线服务包括以下特性： 表1 流水线服务主要功能特性 特性 描述 流水线自定义编排 可根据用户使用场景的需要，对构建、代码检查、子流水线、仓库管理、部署、延时执行、人工审核、接口测试等多种类型的任务进行纳管和执行编排。 流水线可视化增删改查 提供图形化界面的流水线创建、编辑、删除和执行状态查看功能。其中，查看功能支持跳转到对应的任务界面查看其日志等详情信息。 流水线插件管理 插件平台内置多款经典系统插件，满足DevOps日常需求，同时支持插件自定义能力，业务团队开发者可根据自己业务自定义开发流水线插件，以扩展流水线自动化调度能力覆盖的业务范围。 流水线执行参数配置 流水线支持自定义参数，在执行时由用户指定参数值，任务用指定值替换相应参数执行。 流水线执行计划 支持配置事件触发、定时任务、并发策略和抢占策略四种执行计划。 流水线权限管理 支持在项目中配置各角色默认的流水线权限；支持在流水线任务中配置各角色和人员的查看、执行、编辑和删除权限。 流水线通知订阅 用户可根据需要设置事件发生时是否发送通知。 流水线串/并行执行配置 根据用户需求，可配置同一阶段内的任务串行执行或并行执行。 流水线部分任务执行 根据用户需求，可选择流水线中的某一个或多个任务单独执行。 流水线历史执行记录 支持查看流水线最近90天的历史执行记录。 流水线微服务变更 支持基于微服务的DevOps轻量变更模式。 流水线策略分层管理 在租户级和项目级都有策略，实现租户的全局管控和项目的局部管控。 流水线自定义规则 提供了自定义规则能力，可以根据实际需求从插件市场中选择插件生成规则。 流水线准出条件 支持创建规则、策略以实现流水线准出条件的统一管控。 发布管理服务 提供调测与发布编排、自动化上线的发布管理服务，支撑产品DevOps持续交付。

配置流水线钉钉通知 将流水线信息推送到钉钉。 访问CodeArts Pipeline首页。 在流水线列表页搜索目标流水线，单击操作列，选择“编辑”。 进入流水线“任务编排”页面，切换至“通知订阅”页面。 单击“第三方通知”下“钉钉”，根据需要填写通知信息，填写完成后即可激活通知。 图4 配置钉钉通知 表2 配置钉钉通知 操作项 说明 URL 填写钉钉机器人通知URL。 加签密钥 钉钉自定义机器人可以开启安全设置，若未使用加签，无需填写加签密钥。 事件类型 选择要通知的事件，可选择已完成、失败、暂停、挂起、忽略五种事件类型。 通知内容 选择要通知的内容，可选择流水线名称、流水线执行描述、执行人、触发信息、项目名称、执行时间、运行状态七种通知内容。 @user_id 填写要接受通知的飞书的user_id，多个user_id之间以逗号分隔。 配置完成后，保存流水线。

配置流水线飞书通知 将流水线信息推送到飞书。 访问CodeArts Pipeline首页。 在流水线列表页搜索目标流水线，单击操作列，选择“编辑”。 进入流水线“任务编排”页面，切换至“通知订阅”页面。 单击“第三方通知”下“飞书”，根据需要填写通知信息，填写完成后即可激活通知。 图5 配置飞书通知 表3 配置飞书通知 操作项 说明 URL 填写飞书机器人通知URL。 事件类型 选择要通知的事件，可选择已完成、失败、暂停、挂起、忽略五种事件类型。 通知内容 选择要通知的内容，可选择流水线名称、流水线执行描述、执行人、触发信息、项目名称、执行时间、运行状态七种通知内容。 @user_id 填写要接受通知的飞书的user_id，多个user_id之间以逗号分隔。 加签密钥 飞书自定义机器人可以开启安全设置，若未使用加签，无需填写加签密钥。 配置完成后，保存流水线。

配置流水线站内 消息通知 通过服务动态的方式推送通知。流水线执行成功、执行失败、被删除以及配置被更新时，可以配置给创建人、执行人、收藏人发送服务动态。 访问CodeArts Pipeline首页。 在流水线列表页搜索目标流水线，单击操作列，选择“编辑”。 进入流水线“任务编排”页面，切换至“通知订阅”页面。 单击“系统消息”下“站内消息通知”，根据需要开启/关闭通知。 在流水线首页右上角单击，会弹出“通知”侧滑框，即可查看通知消息。 图1 配置服务动态通知 配置完成后，保存流水线。

配置流水线邮件消息通知 通过邮件通知的方式推送通知。流水线执行成功、执行失败、被删除以及配置被更新时，可以配置给创建人、执行人、收藏人发送邮件。 访问CodeArts Pipeline首页。 在流水线列表页搜索目标流水线，单击操作列，选择“编辑”。 进入流水线“任务编排”页面，切换至“通知订阅”页面。 单击“系统消息”下“邮件通知”，根据需要开启/关闭通知。 图2 配置邮件通知 配置完成后，保存流水线。