近期想开发一个Jenkins插件,无奈问了一些同事没有得到我想要的东西,只能自力更生实践一把,下面是记录按照官网文档转译的一些内容,关于开发环境搭建这里就不说了,本篇博客主要介绍Jenkins插件的开发流程,最后发布一个Hello World插件到Jenkins平台,仅供入门一下。
开发一个插件,你需要Maven3和JDK6.0或以上。如果你是第一次使用Maven,确保Maven能够被你从网络中下载下来。
在~/.m2目录下添加settings.xml文件(Windows用户可以在%USERPROFILE%.m2\settings.xml找到,例如:C:\Users\devilwwj.m2):
<settings>
<pluginGroups>
<pluginGroup>org.jenkins-ci.tools</pluginGroup>
</pluginGroups>
<profiles>
<!-- Give access to Jenkins plugins -->
<profile>
<id>jenkins</id>
<activation>
<activeByDefault>true</activeByDefault> <!-- change this to false, if you don't like to have it on per default -->
</activation>
<repositories>
<repository>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
<mirrors>
<mirror>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
<mirrorOf>m.g.o-public</mirrorOf>
</mirror>
</mirrors>
</settings>
配置了这个之后你就可以使用短的前缀来代替Jenkins Maven Plugin(例如: hpi:create可以替代org.jenkins-ci.tools:maven-hpi-plugin:1.6.1:create)。
开始创建一个新的插件,可以使用IDE或者你想更舒适的使用Maven,可以运行以下命令:
$ mvn -U org.jenkins-ci.tools:maven-hpi-plugin:create
也可以直接短的前缀:
$ mvn -U hpi:create
执行完之后会提示输入groupId和artifactid,如下图所示:
如果看到以下提示信息就说明插件创建成功,如下图所示:
通过以下命令对新建的插件进行打包:
$ cd uploadApkToBugly
$ mvn package
打包生成之后会生成一个target目录:
解析: -U 表示Maven会更新所有相关的插件(检查插件的更新) hpi:这个前缀表示Jenkins HPI插件被调用,一个支持Jenkins插件开发的插件 create 表示创建布局目录和新插件的pom.xml文件并且添加它到模块列表 package是一个标准的阶段编译所有资源,运行测试和创建一个包-当使用hpi插件时会创建一个*.hpi文件
构建一个插件,运行mvn install
。这个会创建文件./target/pluginname.hpi,可以让你发布到Jenkins。
$ mvn install
这里我选择的是Eclipse,建议使用Eclipse Juno(4.2或以上)。
$ mvn -DdownloadSources=true -DdownloadJavadocs=true -DoutputDirectory=target/eclipse-classes -Declipse.workspace=/path/to/workspace eclipse:eclipse eclipse:configure-workspace
或
mvn eclipse:eclipse
命令执行成功之后,打开Eclipse使用”import…”然后选择”General” > “Existing Projects into Workspace”。
插件工作空间包含以下主要包含以下几个部分:
pom.xml Maven使用它构建你的插件,所有Jenkins插件都基于父插件:
<parent>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>plugin</artifactId>
<version>2.2</version></parent>
如果使用提供的原型创建项目,一切都已经设置好。截至Jenkins 1.645版本插件父POM是主的Jenkins项目的一部分并且POM版本是Jenkins版本的基准被用于插件。
当使用父POM版本2.2或者更高版本,该基准版本选择使用jenkins.version属性,例如:
<parent>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>plugin</artifactId>
<version>2.2</version>
</parent>
src/main/java 存放插件的java源代码
src/main/resources Jelly/Groovy 视图文件
src/mian/webapp 静态资源文件,例如图片,HTML文件。
Unix:
$ export MAVEN_OPTS="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,address=8000,suspend=n"
$ mvn hpi:run
windows:
> set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,address=8000,suspend=n
> mvn hpi:run
如果你在浏览器打开http://localhost:8080/jenkins ,你会看见Jenkins页面在Jetty中运行。MAVEN_OPTS选项启动端口为8000的调试器,所以你应该能够从IDE在这个端口启动一个调试会话。
一旦开始运行,就保持运行。Jetty会自动拉取所有的变化。
更改端口 如果你需要在不同的端口不是8080启动Jenkins,通过系统属性设置jetty.port端口。
$ mvn hpi:run -Djetty.port=8090
设置上下文路径
$ mvn hpi:run -Dhpi.prefix=/jenkins
maven-hpi-plugin 1.65或更高版本(由父POM 1.401或更高版本使用)可以通过使用系统属性设置上下文路径。在较新版本的Jenkins会自动添加”/jenkins”前缀。
当调试时改变代码 根据你改变什么,你可以看到它运行的实例无需重新启动整个Maven进程:
要创建插件的发布镜像,运行一下的Maven命令:
$ mvn package
这个会在target目录下创建一个.hpi的文件,其他用户可以使用Jenkins的Web界面去上传这个插件到Jenkins(或者将它放置到$JENKINS_HOME/plugins下.):
选择”高级”,然后上传插件:
然后你创建一个任务,就可以在构建当中看到我们发布的名字:
选中之后就可以看到效果如下:
ok,到现在你已经成功将Demo插件发布到Jenkins了。
最后说一下,编程开发有时候其实是一个很死的东西,只要花时间去研究和实践没啥搞不出来的,我们在做任何实践,第一步可能就是去查找资料,无论是百度还是Google,我们去搜都可以搜到别人以前总结的东西,但有时候发现并没有什么卵用,这个时候看官方文档是最好的选择,也是最权威的资料,官方文档全都是英文怎么办,说实在我的英文也不太好,但花时间慢慢啃还是可以搞懂,所以第二步就是搞懂官方的文档,最后就是进行实践踩坑,把最基础的东西搞懂,后面根据自己的需求驱动自己去学这门技术,这样或许会更有效一点。