こんにちは、開発担当の松本です。
今回は、Jenkins にたくさんあるプラグインの中からおすすめのプラグインをいくつか紹介します。
ジョブ一覧にアイコンを追加できる: Custom Job Icon
今年8月にリリースされた比較的新しいプラグイン。名前の通りプロジェクトごとにアイコンを登録できて、それがプロジェクト一覧に表示されるようにできます。
利用するには、プラグインインストール後にアイコンを登録する必要があります。
「Jenkins の管理」→「システムの設定」ページに「Custom icons」セクションが追加されていますので、そこでファイルを追加しておきます。追加しても「Refresh icon list」をクリックしないと表示が更新されない点に注意。
なお、画像の拡大縮小あまりきれいに行われないので、アイコンのサイズは 24 x 24 にしておくのがよいみたいです。
アイコン追加後は、各プロジェクトの設定ページから「Use custom icon」にチェックを入れるとアイコンが指定できるようになります。
プロジェクトビューが「すべて」だとアイコンの位置が右端になってしまうので、それが不満な方は Dashboard View を利用してください。こちらはカラムの順番が編集可能です。
余談ですが、デフォルトビューは「システムの設定」ページで変更可能なことを今まで知りませんでした。これからは Dashboard View をデフォルトビューにしたいと思います。
Markdown風表示で書ける: PegDown Formatter
人によりけりですが、個人的にはプロジェクト概要などで HTML をわざわざ書く気にならないので入れています。
プラグインをインストール後に「Jenkins の管理」→「システムの設定」ページのマークアップ記法を PegDown に変更するだけです。
必要のなくなったプロジェクトをアーカイブできる: Shelve Project
このプラグインを利用すると、プロジェクトをアーカイブして保存することができます。
プラグインをインストール後にプロジェクトのメニューに「Shelve Project」という項目が追加され、ここからプロジェクトを Shelve できます。
Shelve した後は一覧から見えなくなりますが、後で必要になったときに「Shelved Projects」から元に戻すことも可能です。
元に戻したいプロジェクトをチェックして「Unshelve Project」をクリック。
今まで、プロジェクトをビューの設定で見えなくしていましたが、このプラグインを使うとどのビューでも見えなくなるので、不要なプロジェクトに対してはこれを使っています。
特定ビルドのパラメータを再利用できる: Rebuild
パラメータが沢山あるプロジェクトで、前のビルドと同じパラメータを指定する手間を省いてくれるプラグイン。
プラグインをインストール後にプロジェクトのメニューに「Rebuild」という項目が追加され、ここからパラメータを再利用できます。
パラメータ編集もできるので、「このビルドのパラメータをちょっとだけ修正してビルドしなおしたい」などというときにも便利です。
ただし、後述する「Validating String Parameter」をプロジェクト内で利用している場合にエラーになるので注意。
チェック付き文字列パラメータを追加する: Validating String Parameter
パラメータに定型の文字列を入れたくなる状況はわりと発生しますが、そんなときにはこのプラグイン。
入力パターンの指定は Java の正規表現 で行います。
ただし、入力エラーになっていても、ビルドボタンは押せてしまうのが残念なところ (次のようなメッセージが出てビルド失敗になりますが)。
ERROR: Invalid value for parameter [version] specified: 3.8.3.7000a
別プロジェクトのワークスペースの内容をコピーできる: Clone Workspace SCM
今まで、プロジェクト間で必要なファイルを渡すときは、成果物を wget したり、Copy Artifact を使ったりしていましたが、
実際の成果物があり、それと分けたいときにちょっと困っていました。
そんなときにはこのプラグイン。別プロジェクトのワークスペースをソースコード管理システム下にあるように見せかけるプラグインです。
クローンさせてもよいファイルをクローン元で指定できるので不要なファイルを持ち込ませないようにできます。
また、SCM ポーリングにも対応しており、これを利用したときはプロジェクトの上流下流の関連は表示されなくなります。
そのため、Build Pipeline に表示させたくないときなどに便利そうです。
ログ出力から失敗ビルドにしたり色付けさせたりできる: Log Parser
指定した正規表現によって、ログに色付けをしたりビルドを失敗ビルドや不安定ビルドにマークさせたりできるプラグインです。
使い方は少々複雑です。まず、正規表現に対してどの状態 (ok, error, warning, info など) と見なすかを定義したファイルを作成する必要があります。
ルールファイルの例を次に示します。
error /(?i)^error / info /^\d+>------ / info /^========== /
このファイルは 1 行 1 ルールになっており、1行目は、「(大文字小文字は関係なく) 行頭が error の行は error 状態と見なす」という意味になります。
ルールファイルを作成したら、それを Jenkins マシンに入れておき、「Jenkins の管理」→「システムの設定」→「Consle Output Parsing」の Parsing Rules File に指定しておきます。
そしてビルド後の処理に「Console output (build log) parsing」を追加すれば OK。
これで、以降のビルドに「Parsed Console Output」という項目が追加されて、そこで上記のような出力を見ることができます。
ただし、次のような点に注意してください。
- ・ ログ表示のときに UTF-8 以外は変換されないため文字化けしてしまう
- ・ ルールファイルの改行コードは Unix でないとだめ
- ・ ログが長い場合に表示がかなり重くなる
個人的にはログ表示からビルドを失敗にさせたりすることができるので、便利そうだなあとは思ってはいますが、うまく使いこなせていません。
表示言語を強制的に変更できる: Locale
ブラウザなどの環境に関係なく、Jenkins で表示されるページの表示言語を強制的に変更することができます。
利用法は、プラグインをインストール後に「Jenkins の管理」→「システムの設定」→「Locale」に行き、「Default Language」を変更するだけです。
おわりに
上記に出てきたプラグイン以外にも、
- ・ Disk Usage: ディスク利用量の表示
- ・ JobConfigHistory: 設定履歴の表示
- ・ Parameterized Trigger: 下流プロジェクトにパラメータを引き継ぎ
- ・ Growl: Growl で通知
- ・ Redmine: Redmine と連携
- ・ Python
など、便利なプラグインが一杯です。みなさんもお勧めのプラグインがあればぜひ紹介してください。
ソーシャルアカウント
フェンリルのオフィシャル Twitter アカウントでは、フェンリルプロダクトの最新情報などをつぶやいています。よろしければフォローしてください！
関連記事
