Eclipse で Jenkins Plugin を作ってみる

お疲れ様です！Jenkins でビルドする際にあったらいいなって思うプラグインを作ろうかと思ったので Windows10 で開発環境を整えてみました。Plugin tutorial – Jenkins – Jenkins Wiki （日本語）を参考にしています。
日本語のドキュメントは作成日付が少し古いようなので英語の方をメインにしています。

Java SE Development Kit のインストール
Maven のインストール
新規プラグインの作成
- 作業フォルダの作成
- maven プロジェクトの作成
Eclipse のインストール
- インストール
- プラグインプロジェクトを開く
関連記事

Java SE Development Kit のインストール

インストール

下記から JDK をダウンロードしてインストールします。
※記事作成時 1.8.0_162

Java SE Downloads

環境変数の設定

下記の環境変数を追加します。
JAVA_HOME はインストール時に指定したフォルダ名に置き換えてください。
PATH が既にあるときは編集で追記してください。

変数名	内容
JAVA_HOME	%programfiles%\Java\jdk1.8.0_162
PATH	%JAVA_HOME%

環境変数の追加する画面は次の方法で表示できます。

Windowsキー + E
エクスプローラー画面：左側のナビゲーションウィンドウ＞「PC」を右クリック＞「プロパティ」
コントロールパネル画面（システム）：システムの詳細設定
システムのプロパティ画面：環境変数＞ユーザー環境変数

設定の確認

コマンドプロンプトで動作を確認します。

C:\Users\note>java -version
java version "1.8.0_162"
Java(TM) SE Runtime Environment (build 1.8.0_162-b12)
Java HotSpot(TM) 64-Bit Server VM (build 25.162-b12, mixed mode)

コマンドプロンプトは次の方法で表示できます。

Windowsキー押下＞「cmd」と入力してEnter

Maven のインストール

インストール

下記から Binary zip archive をダウンロードします。
※記事作成時 3.5.2

Maven – Download Apache Maven

zip ファイルを展開します。
ここでは「C:\Bin\」へ展開しフォルダ名を「apache-maven-3.5.2」から「maven」に変更します。

環境変数の設定

下記の環境変数を追加します。
PATH が既にあるときは編集で追記してください。

変数名	内容
PATH	C:\Bin\maven\bin

設定の確認

コマンドプロンプトで動作を確認します。
※上のコマンドプロンプト画面とは別の画面を表示してください。

C:\Users\note>mvn -v
Apache Maven 3.5.2 (138edd61fd100ec658bfa2d307c43b76940a5d7d; 2017-10-18T16:58:13+09:00)
Maven home: C:\Bin\maven\bin\..
Java version: 1.8.0_162, vendor: Oracle Corporation
Java home: C:\Program Files\Java\jdk1.8.0_162\jre
Default locale: ja_JP, platform encoding: MS932
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"

settings.xml の作成

ユーザープロファイルフォルダ配下にある .m2 フォルダへ settings.xml ファイルを作成します。
.m2 フォルダが無いときは次のコマンドで作成します。

C:\Users\note>mkdir %USERPROFILE%\.m2

settings.xml ファイルの内容は Plugin tutorial – Jenkins – Jenkins Wiki#Setting Up Environment に記載されています。　
社内等でプロキシサーバーを使っているときは Maven – Guide to using proxies を参考に settings.xml ファイルを変更します。

新規プラグインの作成

作業フォルダの作成

maven プロジェクトの作成先となるフォルダを作成します。ここでは C:\Users\note\Source\JenkinsPlugins を作業フォルダとします。

maven プロジェクトの作成

次の maven コマンドを実行します。

C:\Users\note>cd /d C:\Users\note\Source\JenkinsPlugins
C:\Users\note\Source\JenkinsPlugins>mvn archetype:generate -Dfilter=io.jenkins.archetypes:plugin
...
... 色々ダウンロードされる
...

作成するプロジェクトを選択します。
新規で空のプロジェクトなら「1」ですが、最初なのでサンプルを含んだ「3」を選びます。

Choose archetype:
1: remote -> io.jenkins.archetypes:empty-plugin (Skeleton of a Jenkins plugin with a POM and an empty source tree.)
2: remote -> io.jenkins.archetypes:global-configuration-plugin (Skeleton of a Jenkins plugin with a POM and an example piece of global configuration.)
3: remote -> io.jenkins.archetypes:hello-world-plugin (Skeleton of a Jenkins plugin with a POM and an example build step.)
Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): :3

どのバージョンにするか聞かれるので最新を選びます。
※デフォルトは「3」の最新になるのでそのまま Enter キーを押下します。

Choose io.jenkins.archetypes:hello-world-plugin version:
1: 1.1
2: 1.2
3: 1.3
Choose a number: 3:

「artifactId」を聞かれるのでここでは適当に指定しておきます。

Define value for property 'artifactId':miyabis-hello-world-plugin

バージョンを聞かれるのでデフォルトのままにします。

Define value for property 'version' 1.0-SNAPSHOT: :

これでいいか確認されるのでそのまま実行すると作成されます。

Confirm properties configuration:
groupId: unused
artifactId: miyabis-hello-world-plugin
version: 1.0-SNAPSHOT
package: io.jenkins.plugins.sample
    Y: :

[INFO] ----------------------------------------------------------------------------
[INFO] Using following parameters for creating project from Archetype: hello-world-plugin:1.3
[INFO] ----------------------------------------------------------------------------
[INFO] Parameter: groupId, Value: unused
[INFO] Parameter: artifactId, Value: miyabis-hello-world-plugin
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: package, Value: io.jenkins.plugins.sample
[INFO] Parameter: packageInPathFormat, Value: io/jenkins/plugins/sample
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: package, Value: io.jenkins.plugins.sample
[INFO] Parameter: groupId, Value: unused
[INFO] Parameter: artifactId, Value: miyabis-hello-world-plugin
[INFO] Project created from Archetype in dir: C:\Users\note\Source\JenkinsPlugins\miyabis-hello-world-plugin
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 18:20 min
[INFO] Finished at: 2018-02-25T14:56:42+09:00
[INFO] Final Memory: 15M/155M
[INFO] ------------------------------------------------------------------------

ビルドして確認してみます。

C:\Users\note\Source\JenkinsPlugins>cd miyabis-hello-world-plugin
C:\Users\note\Source\JenkinsPlugins\miyabis-hello-world-plugin>mvn package
...
... 色々ダウンロードされる
...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 03:25 min
[INFO] Finished at: 2018-02-25T15:24:17+09:00
[INFO] Final Memory: 73M/1208M
[INFO] ------------------------------------------------------------------------

「BUILD SUCCESS」すればビルド環境は整っています。

Eclipse のインストール

インストール

下記から「Eclipse 4.7 Oxygen」＞「Windows 64bit」「Full Edition」「Java」をダウンロードします。
※記事作成時 4.7.2.v20171225

Pleiades – 日本語化プラグイン Eclipse, IntelliJ, PhpStorm…

zip ファイルを展開します。
ここでは「C:\Bin\Eclipse」へ展開します。

プラグインプロジェクトを開く

ワークスペースの作成

「C:\Bin\Eclipse\pleiades\eclipse\eclipse.exe」を実行します。
ワークスペースの保存先を指定されるのでデフォルトのまま実行します。
デフォルトだと「C:\Bin\Eclipse\pleiades\workspace」にワークスペースが作成されます。

Eclipse プロジェクトファイルの作成

次のコマンドを実行して先ほど作成したプラグインプロジェクトへ Eclipse プロジェクトファイルを作成します。
オプションの「-Declipse.workspace」は上記で作成したワークスペースのパスを指定してください。

C:\Users\note\Source\JenkinsPlugins>mvn -DdownloadSources=true -DdownloadJavadocs=true -DoutputDirectory=target/eclipse-classes -Declipse.workspace=C:\Bin\Eclipse\pleiades\workspace eclipse:eclipse eclipse:configure-workspace
...
... 色々ダウンロードされる
...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building TODO Plugin 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-eclipse-plugin:2.10:configure-workspace (default-cli) @ miyabis-hello-world-plugin ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 05:58 min
[INFO] Finished at: 2018-02-25T18:54:48+09:00
[INFO] Final Memory: 39M/765M
[INFO] ------------------------------------------------------------------------