通过流水线自定义插件把控发版时间

方案概述

自定义插件是流水线中用于实现特定业务逻辑的模块，通过定义输入、脚本、输出，将处理业务逻辑的过程封装为插件，方便在流水线内复用。流水线提供了许多官方插件供用户使用，同时也允许用户配置满足个性化新需求场景的自定义插件。本文介绍如何创建一个图形化自定义插件，用于把控发版时间，并介绍自定义插件内如何使用参数、如何定义和使用输入与输出，结合规则与策略将输出结果用于流水线准出条件。

流水线门禁是指在流水线执行过程中设置的检查点，用于确保只有满足特定条件的情况下，流水线才能继续执行。本文中创建的自定义插件通过与流水线门禁结合，实现对发版时间的控制，即如果手动执行本插件的时间早于安全发版时间，则门禁不通过。

准备工作

已开通并授权使用CodeArts Pipeline。
已通过统一身份认证服务配置“CloudPipeline Tenant Rules FullAccess”、“CloudPipeline Tenant Rule Templates FullAccess”和“CloudPipeline Tenant Extensions FullAccess”系统策略。配置操作可参考委托其他云服务管理资源。
新建项目（选择“Scrum”模板，命名为“Project_Test”）。
新建代码仓库（选择“Java Maven Demo”模板，命名为“Repo_Test”）。
基于已创建的代码仓库新建流水线（模板选择“空模板”，命名为“Pipeline-Test”）。

步骤1：创建自定义插件

登录华为云控制台页面。
单击页面左上角，在服务列表中选择“开发与运维 > 流水线 CodeArts Pipeline”。
单击“立即使用”，进入流水线服务首页。
单击顶部导航栏“服务”，在下拉框中选择“扩展插件”，单击进入“扩展插件”页面。

单击

，进入“基本信息”页面，参考表1填写基本信息。

表1 自定义插件基本信息
配置项	取值样例	参数说明
图标	-	插件封面图，不上传将会自动生成系统图标。支持PNG、JPEG、JPG格式，文件大小不超过512KB，建议128*128px。
名称	Release Time Control	插件在插件市场和流水线显示的名称。仅支持空格、中文、大小写英文字母、数字、“-”、“_”、“.”，长度不超过50字符。
唯一标识	ReleaseTimeControl	插件的唯一标识，设置后不可修改。
插件类型	通用	插件的类型。支持构建、代码检查、测试、部署、通用共5种类型，设置后不可修改。
插件描述	-	描述插件使用方法。

配置完基本信息后，单击“下一步”，进入“版本信息”页面，使用默认版本号。

单击“下一步”，进入“输入配置”页面。从左侧组件库拖拽“单行输入”组件到画布中，参考表2配置组件信息。

表2 组件信息
配置项类别	配置项	说明
基本	唯一标识	输入“safe_release_time”。
	组件标题	输入“安全发版时间”。
	提示信息	输入“24小时制，最早可发版的时间，例如193000，表示最早可发版的时间为19:30:00”。
	预设提示语	输入“24小时制，最早可发版的时间，例如193000”。
校验	必填	开启。
校验	正则校验	输入“^\d{6}$”。

单击“下一步”，进入“插件编排”页面，将鼠标移至“执行shell”插件，单击“添加”。根据以下示例，输入shell命令，生成标签名称。

# 提取安全时间的小时、分钟、秒
safe_hour="${safe_release_time:0:2}"
safe_minute="${safe_release_time:2:2}"
safe_second="${safe_release_time:4:2}"
 
# 验证时间有效性
if [[ "$safe_hour" -gt 23 || "$safe_minute" -gt 59 || "$safe_second" -gt 59 ]]; then
    echo "错误：safe_time 包含无效的时间值"
    echo "ALLOW_RELEASE=false"
    exit 1
fi
 
# 获取当前时间（24小时制）
current_time=$(date +%H%M%S)
current_hour=$(date +%H)
current_minute=$(date +%M)
current_second=$(date +%S)
 
echo "当前时间: $current_time"
echo "安全时间: $safe_time"
# PIPELINE_TRIGGER_TYPE 为系统预定义变量
echo "流水线触发类型: $PIPELINE_TRIGGER_TYPE"
 
# 判断逻辑
if [[ "$PIPELINE_TRIGGER_TYPE" != "Manual" ]]; then
    # 自动触发 - 直接允许发版
    echo "自动触发模式，允许发版"
    ALLOW_RELEASE="true"
else
    echo "手动触发模式，检查当前时间是否在安全发版时间之后..."
    
    # 将时间转换为秒数进行比较
    current_total_seconds=$((10#$current_hour * 3600 + 10#$current_minute * 60 + 10#$current_second))
    safe_total_seconds=$((10#$safe_hour * 3600 + 10#$safe_minute * 60 + 10#$safe_second))
    
    if [[ $current_total_seconds -ge $safe_total_seconds ]]; then
        echo "检查通过：当前时间已到达安全发版时间，允许发版"
        ALLOW_RELEASE="true"
    else
        echo "检查不通过：当前时间未到达安全发版时间，禁止发版"
        ALLOW_RELEASE="false"
    fi
fi
 
echo "ALLOW_RELEASE=$ALLOW_RELEASE"
#将结果输出到插件的任务门禁输出
echo ::set-metrics var=ALLOW_RELEASE:$ALLOW_RELEASE

单击“下一步”，进入“输出信息”页面。单击“新增配置”，参考表3填写基本信息。

表3 输出配置信息
配置项	取值样例	参数说明
标识	ALLOW_RELEASE	对应脚本里的输出，通过标识解析输出变量。
类型	metric	metric类型的输出在任务结果页面的“其他”卡片展示，可用于输出指标解析，输出信息可以在规则中通过该插件进行引用，并最终应用到流水线。
描述	是否可以发版	描述会在配置规则时，展示在阈值配置的检查项。
分组名称	发版时间	类别名称。