qci-plugin

文章内容

环境安装
运行机制
本地调试

为提升插件开发的便利性，插件系统提供一套基于 Python 环境的开发工具 qci-plugin；它的设计理念是以一种简单的方式将构建代码与构建脚本分离, 让构建脚本（编译, 检查, 测试, 发布）得到尽可能的复用，具备以下特点：

基于 python 3.x 环境, 开发简单。
使用命令行方式执行, 与开发普通的命令行(CMD) 脚本基本无异。
可以通过简单的声明式实现在 CODING CI 渲染配置组件, 便于流水线配置和编辑, 同时也保留直接执行的能力。
支持结果上报。
支持个性化的结果展示。

借助此工具能够快速创建插件结构、运行和测试插件逻辑、提交插件，点击了解具体的开发指引。

环境安装

依赖安装：python>=3.6.8，点击访问下载地址。
安装执行器

执行器的包已上传至公开制品仓库，你可以通过命令行快速安装。

pip install qciplugin -i https://coding-public-pypi.pkg.coding.net/cci/qci/simple/ --trusted-host coding-public-pypi.pkg.coding.net --extra-index https://mirrors.cloud.tencent.com/pypi/simple/

验证是否安装成功：

qci-plugin -h

运行机制

插件通过 qci-plugin 命令启动：

# 运行本地插件, 第一个参数为 qciplugin.yml 所在目录的路径
qci-plugin ./ --arg1 "hello world"

# 使用最新的公开版本运行, 第一个参数为 "插件 ID"
qci-plugin my_plugin_id --arg1 "hello world"

# 使用指定的版本运行
qci-plugin my_plugin_id@1.0 --arg1 "hello world"

本地调试

插件支持在本地直接运行调试。添加 QCI_PLUGIN_DEBUG=1 环境变量可以查看更多调试信息，运行中的警告提醒不会影响实际执行。

qci-plugin [local path] [arguments...]

// local path: 插件本地路径(指 qciplugin.yml 所在目录)
// arguments: 插件参数

问题反馈 >

2024-10-23最近更新

感谢反馈有用

感谢反馈没用