场景介绍
Cloud Native
Flow-CLI 是云效流水线 Flow 推出的一款命令行工具，帮助用户定制开发自己的流水线步骤或组件，满足自定义步骤逻辑或对接三方自有平台等场景，以扩展流水线能力。
Flow-CLI V2 基于TypeScript 编写步骤逻辑，相较于 Flow-CLI V1 shell 脚本编写方式，V2 版本具备如下优势：
基于 TypeScript 编写步骤，步骤代码可测试、质量更稳定。 步骤一次开发，可支持多操作系统/架构运行。 可复用 @flow-step/step-toolkit sdk 提供的基础能力，步骤开发更快速便捷。示例步骤代码及 SDK 详见：https://atomgit.com/flow-step/step-toolkit/blob/main/examples/README.md
场景示例：开发一个
带红线功能 Sonar 扫描步骤
Cloud Native
确保本地已经安装 NodeJS，之后在命令提示符中输入以下命令进行 Flow-CLI V2 的安装。
npm i -g @flow-step/flow-cli --registry=https://registry.npmmirror.comflow-cli -h # 输出帮助信息说明安装成功
flow-cli login # 登录flow-cli 将会自动打开浏览器进入 Flow 登录页面，如果已经登录会提示 success，登录成功后命令行会提示选择账号下企业，输入企业对应的数字进入企业。
参考 RedlineSonar 示例代码 https://atomgit.com/flow-step-custom/RedlineSonar，本地拉取示例代码：
git clone https://atomgit.com/flow-step-custom/RedlineSonar.git.├── README.md # 步骤说明├── package.json # typescript 工程包声明├── src # 步骤后端执行逻辑│ ├── index.ts│ └── params.ts├── step.yaml # 步骤前端展示描述信息 yaml├── tsconfig.eslint.json└── tsconfig.json
步骤前端展示 step.yaml
step.yaml[2]文件定义了步骤前端描述，用于定义步骤执行所需的输入参数。参数说明如下：
本步骤定义以下几个表单，作为步骤执行参数输入：
Sonar 服务器地址 Sonar Token Sonar Project Key 红线信息
---apiVersion: v2kind: DefaultJobid: RedlineSonarname: RedlineSonardescription: flow redline check with sonarhelpUrl: https://atomgit.com/flow-step-custom/RedlineSonarexecution:executor: nodemain: dist/index.jsitems:- label: Sonar服务器地址name: STEP_SONAR_HOSTtype: input- label: Sonar Tokenname: STEP_SONAR_TOKENtype: passwordrules:- require: false- label: Sonar Project Keyname: STEP_SONAR_PROJECT_KEYtype: input- label: 红线信息name: CHECK_REDLINEStype: addable_grouprules:- require: falseadd_button:type: iconicon: plustext: 增加红线tip:icon: question-circledescription: 红线校验失败任务将失败template:items:- name: redlinelabel: 红线position: flattype: custom_redline_dropdowndatamap: '[{"key": "Bugs","type": "LE"},{"key": "Vulnerabilities","type": "LE"},{"key": "Smells","type": "LE"},{"key": "Coverage","type": "GE"}]'rules:- require: false
步骤后端执行逻辑 src/index.ts
1. 输出基础信息和检验步骤入参
2. 调用 sonar api 获取指定项目的指标数据（私有项目需要指定 STEP_SONAR_TOKEN）
3. 将 sonar 返回数据格式化为红线数据
4. 调用 sdk 进行红线检验和记录报告链接信息
async function runStep(): Promise<void> {const params = getParams()// 输出基础信息和检验入参logAndValidParams(params);// 调用 sonar api 获取指定项目的指标数据const metrics = await requestSonarMetrics(`${params.sonarHost}/api/measures/search`, params.sonarToken, {projectKeys: `${params.sonarProjectKey}`,metricKeys: 'alert_status,bugs,reliability_rating,vulnerabilities,security_rating,code_smells,sqale_rating,duplicated_lines_density,coverage,ncloc,ncloc_language_distribution'})step.infoCyan(`Sonar Metrics: ${JSON.stringify(metrics)}`)const bugs = Number(metrics['bugs'])const vulnerabilities = Number(metrics['vulnerabilities'])const smells = Number(metrics['code_smells'])const coverage = Number(metrics['coverage'])// 准备红线数据const readlineResults = [] as RedlineResult[]const bugsRR = generateRedlineResult("Bugs", "缺陷", bugs, redline.Error);readlineResults.push(bugsRR)const vulnerabilitiesRR = generateRedlineResult("Vulnerabilities", "漏洞", vulnerabilities, redline.Error);readlineResults.push(vulnerabilitiesRR)const smellsRR = generateRedlineResult("Smells", "坏味道", smells, redline.Error);readlineResults.push(smellsRR)const coverageRR = generateRedlineResult("Coverage", "覆盖率", coverage, redline.Warning);readlineResults.push(coverageRR)// 调用 sdk 进行红线检验和记录报告链接信息const redlineInfo = {} as RedlineInforedlineInfo.title = 'Redline Sonar'redlineInfo.reportUrl = `${params.sonarHost}/component_measures?id=${params.sonarProjectKey}`redlineInfo.readlineResults = readlineResultsconst checkResult = step.redline.redlineCheck(redlineInfo, process.env['CHECK_REDLINES'])if (!checkResult){step.error('Redline check failed')process.exit(-1)}}
flow-cli step publish编辑后保存并运行流水线，查看步骤运行结果和日志：
以上即完成了一个企业自定义步骤的开发，完成了 Sonar 服务的对接。
https://help.aliyun.com/zh/yunxiao/user-guide/how-to-use-cloud-efficiency-pipeline-for-ci-cd-in-private-network-environment
https://atomgit.com/flow-step-custom/RedlineSonar/blob/master/step.yaml
