Jenkinsプラグイン探訪 - Sidebar-Link Plugin

はじめに

システムレベルのお話

Jenkinsのページのうち、参照頻度の高いページが少し深い階層に存在していることがあります。Permalinkが設定されているページであれば、ビューの説明欄にそのページへのリンクを記述して、階層を浅くすることができます。
この説明欄を用いる方法は、表現力が高く、柔軟にカスタマイズできるところが魅力ですが、ビューごとにリンクを記述する必要があるので、複数箇所に同じリンクを記述したい場合に少し不便です。

プロジェクトレベルのお話

開発プロジェクトで情報共有用サイトを運用している場合、そのサイトにJenkinsへのハイパーリンクを記述しているのではないでしょうか。しかし、その逆(Jenkinsからサイトへ)はというと、サイトへのリンクを設定していない場合が多いのではないかと思います。
ここで上記と同様に、プロジェクトの説明欄にそのサイトへのリンクを記述して、相互リンクにすることができます。しかし、プロジェクトの説明欄は、プロジェクトのトップページにしか存在しないので、アクセシビリティがあまり向上しません。

そこで...

今回はこれらの状況を改善するための一手段として、Sidebar-Linkプラグインを紹介したいと思います。

なお、このプラグインは、簡潔に述べると、

  • Jenkinsのグローバルメニュー(サイドバー)や
  • Jenkinsのプロジェクトメニュー(サイドバー)に
  • ユーザ定義のハイパーリンク

追加するための機能を提供します。

インストール

Sidebar-Link Pluginの名称と関連URLは次のとおりです。

プラグイン Wiki URL ダウンロード URL GitHub URL
Sidebar-Link Plugin http://wiki.jenkins-ci.org/display/JENKINS/Sidebar-Link+Plugin http://updates.jenkins-ci.org/download/plugins/sidebar-link/ https://github.com/jenkinsci/sidebar-link-plugin

機能概要

Sidebar-Linkプラグインの機能概要は次のとおりです。

  • グローバルメニューに追加するハイパーリンクのURL、テキスト、アイコンを、システム設定から複数個登録することができます。


  • プロジェクトメニューに追加するハイパーリンクのURL、テキスト、アイコンを、各プロジェクトの設定から複数個登録することができます。


機能詳細と注意事項

Sidebar-Linkプラグインの機能詳細は次のとおりです

  • アイコンのサイズは24x24です。
  • 24x24より大きなサイズで登録されたアイコンは、描画時に24x24にリサイズされます。
  • 「JENKINS_HOME/war/images/24x24」ディレクトリ内のアイコン(例えば、clipboard.png)を使用する場合は、リンクアイコン欄に「clipboard.png」と記述します。
  • 「JENKINS_HOME/userContent」ディレクトリ内に配置した自作のアイコン(例えば、image.png)を使用する場合は、リンクアイコン欄に「/userContent/image.png」と記述します。
  • その他は「機能概要」を参照してください。

利用のポイント

  • Jenkinsのページのうち、参照頻度が高いページへのリンクをサイドバーに登録することで、アクセシビリティが向上します。(JekinsのルートURLから相対的に指定して下さい)
  • 疎な連携ではありますが、(開発プロジェクトごとに運用している)情報共有用サイトとの相互リンクを充実させることで、サイト同士の一体感が向上します。

おわりに

どんなUIでもそうですが、すべての人にベストマッチするUIというものはあり得ません。ツールを浸透させるためには、ちょっとした工夫を施してチームにとって使いやすいと思えるUIにカスタマイズしていくことも重要だと思います。
また、サイト同士を連携させることによって、必要な情報を得るための負担を多少なりとも減らすことができます。