Jenkins插件开发(二)-- HelloWorld

在上一篇blog中我们讲了如何搭建jenkins插件的开发环境,接下来介绍如何开发我们的插件。

创建HelloWorld插件

学习每门新语言的时候,我们都会写一个HelloWorld程序,这里介绍的是如何创建一个Jenkins的HelloWorld插件。

1、首先修改Maven的配置,将Maven的连接库修改为jenkins plugins的资源库,方便相关pom组件从jenkins上下载,修改的是 %USERPROFILE%/.m2/settings.xml文件。
settings.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<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>
2、打开CMD,进入一个想要放插件工程的目录,执行以下命令。
1
mvn -U org.jenkins-ci.tools:maven-hpi-plugin:create -DgroupId={your.gound.id} -DartifactId={your.plugin.id}

命令中的 your.groud.id 和 your.plugin.id 填你插件的具体对应的值。

your.group.id 会形成你的包结构,比如 your.group.id=abc.def.ghi,那工程下的src/main/java 目录下会产生abc.def.ghi 这样的目录。

执行完命令后,该目录下会产生一个名称是{your.plugin.id}的目录,这个目录工程就是我们的HelloWorld插件工程。

3、插件打包

创建好工程之后,执行下面的命令可以在 target 子目录下产生一个 hpi 文件,该文件就是我们的插件文件,可以直接上传到 jenkins 的服务器。

1
mvn package
4、启动本地服务

在第三步产生的 hpi 文件要上传到一个部署好的jenkins服务器才可以看到效果,我们也可以通过以下命令启动一个包含插件的本地jenkins服务。

1
mvn hpi:run

执行完命令之后,在浏览器打开localhost:8080,就可以访问本地的Jenkins服务了,这里默认用的是 jetty6的 web 容器。

5、运行HelloWorld插件

在Job的配置页面,其中的构建子项中Add Build Step按钮,点击后下拉框中会有一个Say Hello World的选项,这个就是我们的HelloWorld 插件,选中后保存配置,进行Job构建,在构建日志中就可以看到插件的打印日志。

这里介绍的是新建一个插件,对已有插件进行扩展不在本次讨论范围内,更多信息可以参考这里


Comments