Avisi Git for Confluence 1.15.1 とユース ケースのご紹介

2015-12-16 (Wed)  •  By 伊藤  •  活用のヒント  •  Confluence Git Git for Confluence

はじめに

Avisi Git for Confluence は Git リポジトリと Confluence とを統合し、リアルタイムに同期を取る Confluence 用アドオンです。専用のマクロを使用することで、同期先となる Git リポジトリのソース コードを Confluence ページ上に埋め込むことができます。また、擬似的な添付ファイルとして Confluence ページに添付することも可能です。

2015 年 12 月 11 日、Avisi Git for Confluence 1.15.1 が公開されました。今回のバージョンでは、弊社監修のもと、日本語へのローカライズに対応しています。これにより、言語設定で日本語を選択している Confluence ユーザーでも、違和感なく利用できるようになりました。

スクリーンショット

Avisi Git for Confluence : 接続先 Git サーバーの設定画面
Avisi Git for Confluence : Git サーバーの新規登録ダイアグラム
Avisi Git for Confluence : Git ファイルの埋め込みマクロ
Avisi Git for Confluence : Git ファイルの埋め込みマクロ
Avisi Git for Confluence : Git ファイルの埋め込み結果
Avisi Git for Confluence : Git ファイルの添付
Avisi Git for Confluence : Git ファイルの添付
Avisi Git for Confluence : Git ファイルの添付

Avisi Git for Confluence のユース ケース

今回はこの Avisi Git for Confluence の利用例として、以下のシナリオを考えてみましょう。

  1. 開発チームがソース コードを作成する
  2. 開発チームは、作成したソース コードを Git 上にコミット&プッシュする
  3. テクニカル ライターは Git リポジトリ上のソース コードを引用したテクニカル ドキュメントを執筆する

ここで問題となるのは、主に以下の 2 点でしょう。

  • テクニカル ライターは Git リポジトリにアクセスする必要がある
  • Git リポジトリ上のソース コードが更新される度に Confluence 側でも手動で作業を行う必要がある

しかし、Avisi Git for Confluence を導入することでこれらの問題が解決します。

テクニカル ライターは Git リポジトリにアクセスする必要がない

Git リポジトリ上のソース コードを引用して Confluence ページを作成する場合、テクニカル ライターは以下の操作を行うことになります。

  1. Git リポジトリにアクセスする
  2. 該当のソース コードの内容をコピーする
  3. Confluence 上でコード ブロック マクロを使用してソース コードを埋め込む

しかし、Avisi Git for Confluence を利用した場合、上記 1) と 2) の手間は必要ありません。

Avisi Git for Confluence では、コード ブロック マクロではなく、専用の “Git ファイルの表示” マクロを使用します。このマクロでは、マクロの編集画面で直接 Git リポジトリ上のソース コードを指定できます。したがって、テクニカル ライター自身が Git リポジトリにアクセスする必要はありません。また、コード ブロック マクロ同様、”Git ファイルの表示” マクロでもソース コードのハイライト機能を利用できるので、見栄え良く体裁を整えることが可能です。

Git リポジトリ上のソース コードが更新されても Confluence 側で追加の作業は発生しない

Confluence ページ上にソース コードを埋め込んだ後に、そのソース コードが修正される可能性も考えられます。この場合、修正が発生する度に、テクニカル ライターはコード ブロック マクロを再編集しなければなりません。また、テクニカル ライターはソース コードが修正されたことを HipChat や通知メールなど、何かしらの方法で把握する必要もあります。

しかし、Avisi Git for Confluence の場合、そんな心配は必要ありません。”Git ファイルの表示” マクロは Git リポジトリ上のソース コードを直接参照するため、常に最新のソース コードが Confluence ページ上に反映されます。したがって、参照先のソース コードが修正された場合でも、Git ファイルの表示マクロを再編集する必要はありません。

Avisi Git for Confluence のユース ケース (イメージ)

Avisi Git for Confluence のユース ケース (イメージ)

まとめ

アトラシアン製品向け Git 統合ソリューションというと、JIRA アプリケーション (JIRA Core/JIRA Software/JIRA Service Desk) を想定したものが多数を占めています。しかし、今回ご紹介した Avisi Git for Confluence のように Confluence 向けの製品も提供されています。ぜひ、一度お試しください。

参考


Related Articles

お気軽にお問い合わせください

お問い合わせ