Shoeisha Technology Media

CodeZine(コードジン)

記事種別から探す

REST APIを利用して、JIRAのサマリーを外部エディタで編集してみよう!――外部ツール連携の第一歩

JIRAやConfluenceをもっと使いこなそう! エキスパートが教える、外部ツール連携術 第1回

  • LINEで送る
  • このエントリーをはてなブックマークに追加

 昨今、開発現場での情報共有は必須ともいえるほどに重要視されています。情報共有ツールとしてJIRAやConfluenceといったアトラシアン製品は多くの開発現場で使用されていますが、チームの仕組みに存在するからなんとなく使っている……そのような方も多いのではないでしょうか。しかしせっかくのツール、多種多様な機能をもっと活用したいと思いませんか? 本連載では使い慣れた環境と組み合わせてツールをさらに使いこなす方法を、アトラシアン製品の国内販売代理店であるリックソフトがお伝えします。初回となる今回は、REST APIを利用してJIRAと外部ツールのエディタを連携させる例を紹介します。

目次

はじめに

 今回は、JIRA課題のサマリー(要約)を外部エディタ上で編集してJIRAに書き戻す機能を、JIRAのREST APIとElectron上に構築したテキストエディタを連携させ、実現していきます。

 通常、JIRAのテキストフィールドで一括置換を行いたい場合、CSV Export/Importを使って外部ツール経由で行うなど一手間が必要です。そこで、テキストエディタとREST APIを用いて直接連携すると、便利なテキスト編集機能を使いながら手軽に要約の一括置換ができるようになります。

 実装はJavaScriptとjQueryを組み合わせて行います。

サマリーエディタのイメージ
サマリーエディタのイメージ

必要な環境

 Electron稼働環境(本記事ではv1.6.2を利用しました)

  • macOS 10.9以降, Windows 7以降
  • JIRA6.4以降(サーバ版のみ)

サマリーエディタを動作させてみる

 はじめに、必要なソフトウェアをインストールしてテキストエディタを起動する準備を行います。Node.jsがインストールされていない場合は、Node.jsをインストールします。こちらからダウンロードしてください。

 次に、Electronのインストールを行います。インストール方法はこちらをご参照ください。ここでは以下のコマンドを利用してインストールします。

npm install -g electron

 その後、コマンドラインで以下の通り入力し、ウインドウが立ち上がればインストールは成功です。

electron

 今回、エディタはAceを使用しますが、起動時に外部から読み込むのでインストールは不要です。

 任意の場所に作業用ディレクトリを作成し、そこに移動します。

mkdir test; cd test

 プロジェクトを作成します。

npm init -y

 同じ場所にサンプルファイル内のファイルを全てコピーしてください。

cp (サンプルファイルのディレクトリ)/index.html (サンプルファイルのディレクトリ)/index.js (サンプルファイルのディレクトリ)/editor.js (サンプルファイルのディレクトリ)/editor.css .

 最後に、editor.js内に固定で設定されているJIRAホストURL、ユーザー名、パスワードを環境に合わせて書き換えてください。

 これでテキストエディタを起動する準備ができました。実際に起動してみましょう。以下のコマンドでエディタが起動します。

electron .

 画面左上のダウンロードボタンを押すとJQL(JIRA検索言語)ダイアログが表示されます。JQLフィールドは空のままでも問題ありません。

JQLダイアログ
JQLダイアログ

 ダイアログ上のロードボタンを押すと課題がロードされ、テキストエディタ上には課題キーとサマリーが表示されます。

課題キーとサマリーの表示
課題キーとサマリーの表示

 いくつかのサマリーをエディタ上で編集します。ちなみに、検索&置換機能で一括変換することもできます(macOSの場合はOpt+Command+F)。

編集の様子
編集の様子

 最後にアップロードボタンを押すと、テキストエディタ上で行った編集がJIRAに反映されます。

編集内容がJIRAに反映される
編集内容がJIRAに反映される

  • LINEで送る
  • このエントリーをはてなブックマークに追加

著者プロフィール

バックナンバー

連載:JIRAやConfluenceをもっと使いこなそう! エキスパートが教える、外部ツール連携術
All contents copyright © 2005-2017 Shoeisha Co., Ltd. All rights reserved. ver.1.5