開發Jenkins Plugin(入門篇)
一、前言
Jenkins有豐富的plugins資源提供開發人員使用,但有時候plugin提供的功能並不能完全符合自己的需求,這時候開發人員就必須自行開發符合需求的plugin。
本篇文章將待各位開發人員入門Jenkins Plugin的開發。
二、安裝設定Apache Maven
1.到官網下載https://maven.apache.org/。
2.開啟apache-maven-3.5.4\conf\settings.xml檔案,並利用下列設定取代原有設定。
<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>https://repo.jenkins-ci.org/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>repo.jenkins-ci.org</id>
<url>https://repo.jenkins-ci.org/public/</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
<mirrors>
<mirror>
<id>repo.jenkins-ci.org</id>
<url>https://repo.jenkins-ci.org/public/</url>
<mirrorOf>m.g.o-public</mirrorOf>
</mirror>
</mirrors>
</settings>
三、產生Jenkins Plugin專案架構
1.執行"C:\Program Files\apache-maven-3.5.4\bin\mvn" -U archetype:generate -Dfilter=io.jenkins.archetypes:,產生Jenkins Plugin專案架構。
2.選擇「4: remote -> io.jenkins.archetypes:hello-world-plugin」,建立專案時會附上一個hello的範例。
3.產生完成會如下圖:
4.使用eclipse將剛剛上述Jenkins Plugin專案Import進來,如下圖。可以看到範例HelloWorldBuilder.java。
四、啟動Jenkins Plugin專案範例HelloWorld
1.在「newPlugin」專案上按右鍵,「Run As」-->「Run Configurations…」。
2.在Goals欄位輸入clean hpi:run -Djetty.port=8090,在按下Run。
3.在瀏覽器輸入http://127.0.0.1:8090/jenkins/,就可以進入開發用Jenkins如下圖。
4.建立一個Free-Style專案。
5.進入「建置後動作」,按下「新增建置步驟」選擇「Say hello world」。
6.「Say hello world」就是plugin範例,在欄位輸入文字後再按下「儲存」。
7.在「終端機」的輸出可以看「Say hello world」plugin輸出的字串。
五、封裝 Jenkins Plugin
1.在「Maven Build」內,Goals欄位輸入clean package -DskipTests在按Run。如下圖:
2.在「target」目錄下可以找到封裝完成「newPlugin.hpi」的plugin檔案。
六、安裝Jenkins Plugin檔案
1.在「管理 Jenkins」->「外掛程式管理」內,來上傳剛剛完成的newPlugin.hpi檔案。