Hello,Jenkins

近期想开发一个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,如下图所示:

创建插件1
创建插件2

如果看到以下提示信息就说明插件创建成功,如下图所示:

创建插件3

通过以下命令对新建的插件进行打包:

$ 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

为IDE设置开发环境

这里我选择的是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会自动拉取所有的变化。

  1. 当你让视图发生变化在src/main/resources或者资源文件在src/main/webapp,只要在浏览器按F5就可以看到这些变化。
  2. 当你改变Java源文件,在你的IDE编译它们和Jetty会自动重新部署Jenkins去拉取这些变化。这里没有必要运行一直运行mvn命令。

更改端口
如果你需要在不同的端口不是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进程:

  • Views:Groovy/Jelly 视图每次请求一个页面会被重新编译,所以只刷新浏览器页面,你就会看到变化。这个对你写的帮助文件也是如此。
  • Java Code:如果你在调试,JVM的热插拔功能可以用来重新加载代码,只要你没有动过方法签名。除此之外,你可以在Maven进程中按Enter键然后它会重新加载Jenkins的Web应用。请参阅Developing with JRebel会告诉你如何获得JRebel的OSS项目的许可证去帮助你提高这个方面的经验。
  • POM:如果你更改了POM,你就需要停止并重新启动Maven才能看到变化。

发布一个插件

要创建插件的发布镜像,运行一下的Maven命令:

$ mvn package

这个会在target目录下创建一个.hpi的文件,其他用户可以使用Jenkins的Web界面去上传这个插件到Jenkins(或者将它放置到$JENKINS_HOME/plugins下.):

管理插件

选择"高级",然后上传插件:

这里写图片描述

然后你创建一个任务,就可以在构建当中看到我们发布的名字:

构建的名称

选中之后就可以看到效果如下:

插件效果

ok,到现在你已经成功将Demo插件发布到Jenkins了。

总结

最后说一下,编程开发有时候其实是一个很死的东西,只要花时间去研究和实践没啥搞不出来的,我们在做任何实践,第一步可能就是去查找资料,无论是百度还是Google,我们去搜都可以搜到别人以前总结的东西,但有时候发现并没有什么卵用,这个时候看官方文档是最好的选择,也是最权威的资料,官方文档全都是英文怎么办,说实在我的英文也不太好,但花时间慢慢啃还是可以搞懂,所以第二步就是搞懂官方的文档,最后就是进行实践踩坑,把最基础的东西搞懂,后面根据自己的需求驱动自己去学这门技术,这样或许会更有效一点。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容