Edited at

Redmine で Wiki ページの更新履歴をチケットに関連付けるプラグイン

More than 5 years have passed since last update.


課題

Redmine では、コミットログに refs #1234 message のようにチケットNo. とキーワードを含めておけば、コミットとチケットを関連付けたり、ステータスを更新したり、時間を記録することができます。

しかし例えば、Wiki を使ってドキュメントを作成又はメンテするチケットがあったとき、作業の記録を残すためにわざわざチケットのコメント欄に作業内容とその Wiki へのリンクを入力する必要がありました。


やりたかったこと

ならば、Wiki の更新時に入力するコメントにも、コミットログと同様に refsfixes などのキーワードが使えれば捗るんじゃなかろうかと。


Redmine Issue Wiki Journal プラグイン

というプラグインを作りました。ソースコードは github に公開しています。

https://github.com/hidakatsuya/redmine_issue_wiki_journal


使い方

やりたかったことそのまんまです。

Wiki ページ更新時のコメント欄にコミットログで関連付けるときと同様、キーワードとチケットNo. を入力しておきます。

Wiki ページの更新

で、更新するとチケットに Wikiページとそのバージョンへのリンク、メッセージが記録されます。チケットのコメントに追加しているだけなので(設定されていれば)メールも普通に飛びます。

チケットへ記録される

この画像は言語を英語にしている場合なので、 言語設定が日本語であれば、ちゃんと日本語で記録される はずです(現在は、英語と日本語翻訳のみ対応)

また、画像はないですが、Wiki ページの更新履歴一覧ページに更新時のコメントが表示されますが、その中の #1234 のようなチケットNo. 表記にチケットへのリンクを貼るよう拡張もしてます。言葉では分かりづらいですね... コメント欄に refs #123 message と入力して更新後、Wiki ページの更新履歴ページを見て下さい。


動作環境


  • Redmine 2.2.x, 2.3.x

  • Ruby 1.9.3, 2.0.0


インストール/アンインストール

README.ja にも書いてありますが、 Redmine の公式ガイドをご覧下さい。

http://www.redmine.org/projects/redmine/wiki/Plugins#Installing-a-plugin


セットアップ

初期状態では、終了キーワードに対応するステータスが設定されていないので、そのままでは fixes などの終了キーワードを使ってもステータスの更新は行われません。なので、まず 管理 > 設定 > リポジトリ から終了キーワードに対応するステータスを設定して下さい。

設定


今後

まずは、 Issue にあげてあるタスクを順次対応します。ただその中でも、実装はしてるもののテストコードの無い時間記録機能を対応しようかと思ってます。

詳しい使い方や動きは テストコード が参考になるかもしれません。

よろしければご利用下さい。