9 月 13 日,2025 Inclusion・外滩大会「开源嘉年华」正在限量报名中! 了解详情
写点什么

我的第一款 Drone 插件

  • 2019-11-28
  • 本文字数:2046 字

    阅读完需:约 7 分钟

我的第一款 Drone 插件

前言

Drone 是一款基于 Docker 的 CI 工具,不仅运行环境是容器化的,甚至于 CI 流中的每一个插件也是 docker 容器。基于容器的 Drone 插件一大特色就是允许我们使用任何语言去开发插件,Python, PHP, Nodejs, bash… 这些都是可以的。每个开发者都可以使用自己熟悉的语言去开发自己想要的插件。Drone 的官方插件市场罗列了很多插件,并且在文档提供了 Golang 和 Bash 版本的插件开发文档,并开源了一个插件脚手架。


官方插件里有一个 drone-telegram 插件,不过插件目前是不支持自定义 telegrame 请求地址的,对于我这种机器部署在国内需要使用反代的方式访问 telegram 的用户来说不是很方便。搜索到 node-telegram-api 这个模块可以配置,下面我就简单说说基于 Nodejs 写一个 Telegram 消息通知的插件。


1 原理

Docker 容器在启动的时候可以设置一个启动命令,这样我们就可以做到实例化插件容器的时候就执行插件脚本。另外 Drone 运行插件的时候会将本次 CI 构建相关的信息以及插件配置信息以环境变量的形式注入到插件容器实例中。所有的语言都是可以去读取系统环境变量的,这也让其支持所有语言成为了可能。


  • 插件配置会以 PLUGIN_xxx 的形式注入,例如 PLUGIN_TOKEN。

  • 构建相关的信息会以 CI_xxx 或者 DRONE_xxx 的形式注入,例如 DRONE_COMMIT, CI_COMMIT_AUTHOR_NAME。

2 编写插件

编写插件很简单,只需要注意需要获取的配置使用 PLUGIN_ 获取即可,例如 telegram 需要使用的 PLUGIN_TOKEN 等。下面是具体的插件代码:


const render = require('drone-render');const TelegramBot = require('node-telegram-bot-api');
const { PLUGIN_TOKEN, PLUGIN_TO, TELEGRAM_TOKEN, TELEGRAM_TO, PLUGIN_LANG, PLUGIN_MESSAGE, PLUGIN_BASE_API_URL} = process.env;
const TOKEN = PLUGIN_TOKEN || TELEGRAM_TOKEN;const TO = PLUGIN_TO || TELEGRAM_TO;
if(PLUGIN_LANG) { render.locale(PLUGIN_LANG);}const bot = new TelegramBot(TOKEN, { baseApiUrl: PLUGIN_BASE_API_URL});bot.sendMessage(TO, render(PLUGIN_MESSAGE));
复制代码


可以看到其实代码非常的简单。

3 Dockerfile

插件写好之后就需要创建 Dockerfile 文件制作镜像了。由于 Dockerfile 的每一个指令都会为容器创建一个 layer,所以这里有个小技巧是将 npm install 依赖安装这种不怎么会变化的操作提前,频繁变化的插件脚本的拷贝置后。这样在多次打包发布的时候会占优势,仅仅只会传后面变化的部分,减小传输体积。


FROM mhart/alpine-node:8.9.3
WORKDIR /telegram-nodeCOPY package.json /telegram-node/package.jsonRUN npm install
COPY index.js /telegram-node/index.jsENTRYPOINT [ "node", "/telegram-node/index.js" ]
复制代码


最后就是编译并发布我们的 docker 容器以供其它人方便使用:


docker build lizheming/drone-telegram-node .docker push lizheming/drone-telegram-node
复制代码

4 测试

本地使用如下命令启动镜像即可测试插件是否工作:


docker run --rm \    -e PLUGIN_TOKEN=xxxxxxx \    -e PLUGIN_TO=xxxxxxx \    -e PLUGIN_MESSAGE=test \    -e PLUGIN_BASE_API_URL=xxxx \    lizheming/drone-telegram-node
复制代码

5 问题

secrets 参数获取

经常有些密钥之类的参数不想写在 .drone.yml 配置文件中暴露给所有项目可见的用户,这时候我们就会使用 drone secrets 添加变量,具体可参考我之前写的文章《如何使用Drone》


这里需要注意的是 secrets 定义的变量名即最后 drone 注入进入的环境变量名称,所以不能随意使用。例如你的配置是:


pipline:  telegram:    image: lizheming/drone-telegram-node    secrets: [ telegram_token, telegram_to ]    message: hello
复制代码


最后你在插件内部就能使用 process.env.TELEGTAM_TOKEN 来获取对应的密钥变量。

插件不生效

在编写插件的时候我碰到的一个问题是我最开始的 Dockerfile 是如下这样的:


FROM mhart/alpine-node:8.9.3
WORKDIR /telegram-nodeCOPY package.json /telegram-node/package.jsonRUN npm install
COPY index.js /telegram-node/index.jsENTRYPOINT [ "node", "index.js" ]
复制代码


由于我设置了 WORKDIR 工作目录,正常的 docker run 是可以找到我的入口文件为 ${WORKDIR}/index.js 的。但是 drone 在执行插件的时候由于需要访问项目代码,所以会通过命令覆盖掉镜像的 WORKDIR 配置。导致了我的插件正常运行没问题,但是上到 drone 怎么也执行不了。最后查了才发现是因为复现了工作目录配置后入口文件找不到压根就没执行我的插件的问题。

6 后记

插件的所有代码已经发布在Github



镜像 lizheming/drone-telegram-node 也已发布到 docker hub 上。本插件相对于官方的插件的优势是能够设置 telegram API 接口的地址,对于国内服务使用反代的方式来说比较适合。如果想要在国内服务器上使用 drone telegram 消息通知的可以使用。不知道如何设置 telegram API 反代的也可以参考我的文章《反代访问Telegram》


本文转载自公众号 360 云计算(ID:hulktalk)。


原文链接:


https://mp.weixin.qq.com/s/-h1bZp4N-6F_89XmSH214g


2019-11-28 11:591224

评论

发布
暂无评论
发现更多内容

亮相 LiveVideoStackCon,透析阿里云窄带高清的现在与未来

阿里云CloudImagine

视频编解码 视频处理

anyHouse - Android 仿写 ClubHouse

anyRTC开发者

android 音视频 WebRTC RTC 语音社交

阿里巴巴的“双11”高并发秒杀终极版教程!(Java语言设计)

Java架构追梦

Java 阿里巴巴 架构 面试 秒杀架构设计

轻松带你学习java-agent

华为云开发者联盟

Java Trace Java虚拟机 java-agent 挂载

微服务的演化

箭上有毒

4月日更

没想到【成功的计算机视觉应用】居然是这样部署的!

澳鹏Appen

人工智能 自动驾驶 机器学习 大数据 计算机视觉

飞桨分布式训练又推新品,4D混合并行可训千亿级AI模型

百度大脑

百度 AI 飞桨

事件分发源码,Android事件分发机制收藏这一篇就够了,威力加强版

欢喜学安卓

android 程序员 面试 移动开发

nginx 搭建简单图片服务器实现负载均衡

Java小咖秀

nginx 服务器 图片

20 图 |6 千字|缓存实战(上篇)

悟空聊架构

redis 缓存 缓存穿透 缓存击穿 缓存雪崩

「 社区建设功勋奖名单公布」—— InfoQ 写作平台【 1 周年盛典 】

InfoQ写作社区官方

1 周年盛典 热门活动

4行指令解决pip下载Python第三方库太慢问题(pip更换国内下载源)

不脱发的程序猿

Python pip 4月日更 Python库安装

什么是Selenium?使用Selenium进行自动化测试

码语者

DevOps selenium

网易有道 ASR 团队斩获 Interspeech 2021 算法竞赛两项冠军

有道技术团队

AI 算法竞赛

Android实现文档在线预览功能

寻找生命中的美好

android pdf预览 文档预览

实践案例丨Pt-osc工具连接rds for mysql 数据库失败

华为云开发者联盟

MySQL 数据库 pt-osc工具 rds for mysql

三步法助你快速定位网站性能问题

华为云开发者联盟

html 网站 网站优化 Performance面板 瀑布图

2021年IT行业八大趋势预测

禅道项目管理

自动化 数字化 技术债 行业趋势

【转载】提高系统开发效率的“银弹”——X-series可视化大规模应用开发工具集

赫杰辉

谈谈中台架构之交易中台

艾小仙

Kubernetes入门——Kubernetes应用部署

百度开发者中心

Kubernetes #技术课程#

分布式锁之Redis实现

Sakura

4月日更

GitHub开源:17M超轻量级中文OCR模型、支持NCNN推理

不脱发的程序猿

人工智能 GitHub 开源 OCR 4月日更

5个超好用的Instagram图片下载工具推荐

科技猫

分享 下载 教程 图片 Instagram

手把手教你从数据预处理开始体验图数据库

NebulaGraph

数据库 数据预处理

百度大脑开放日福州站-智能制造与安全生产专场报名啦

百度大脑

百度大脑 开放日

Flink + Hudi 在 Linkflow 构建实时数据湖的生产实践

Apache Flink

flink

事件分发机制Android,熬夜整理Android面试笔试题,精心整理

欢喜学安卓

android 程序员 面试 移动开发

云管平台如何纳管多云资源?

嘉为蓝鲸

云计算 运维自动化 cmp 混合云 多云管理平台

yarn 集群的架构和工作原理

五分钟学大数据

hadoop YARN 4月日更

https如何使用python+flask来实现

华为云开发者联盟

Python flask https ssl HTTP协议

我的第一款 Drone 插件_服务革新_怡红公子_InfoQ精选文章