Jenkins Plugin开发指南

Jenkins Plugin Development Guide

Posted by Robin on April 27, 2017

环境准备

所有Jenkins plugin都是java开发的Maven项目,需要准备如下环境:

  • 安装工具: Maven; JDK 6.0或以上版本,Eclipse
  • 环境变量:PATH中添加mvn.bat路径;JAVA_HOME中添加SDK路径

导入项目

Jenkins plugin项目一般都是开源的,可以在他们的基础上进行定制化。

  1. 从github上git clone项目
  2. import到Eclipse
    • 打开Eclipse,选择“File”->“import”->“Maven”->“Existing Maven Projects”,选择需要导入的项目,忽略import过程中的warnings。
    • 在进行任何操作前,先Run As -> Maven clean,才能保证开发的plugin在Jenkins中可以被看见。

测试

在命令行窗口中plugin项目的目录下执行mvn hpi:run,Maven会在Jetty中启动一个测试Jenkins,并将新开发的plugin部署到Jenkins中。 在浏览器地址栏中输入http://localhost:8080/jenkins即可进入测试Jenkins。 在测试过程中,plugin并没有被打包成hpi文件,而是被打包成hpl文件。hpl文件是一个简单的文本文件,描述plugin相关的所有文件,而不是一个真正的package文件。

构建

Jenkins的所有plugin都是通过hpi的文件格式发布的,所以在发布前先要自己开发的plugin打包成hpi文件。 在命令行窗口中plugin项目的目录下执行mvn package,即可自动在target目录下的生成该plugin的hpi文件和jar文件。

Reference