Wikiの変更をチケットに紐付けるRedmineプラグインを書いた

redmine

@は激怒した。
必ずかの邪智暴虐のPMを凹ませねばならぬと決意した。

@には社内政治がわからぬ。@はエンジニアである。
JavaScriptを書き、ビッグデータと遊んでくらしてきた。
けれども、トレーサビリティには人一倍に敏感であった。

ある日、社内をあるくうちに、@はあるプロジェクトの様子を怪しく思った。
ひっそりしている。もう既に日も落ちて、そとの暗いのは当りまえだが、けれども、なんだか、夜のせいばかりでは無く、プロジェクト全体が、やけに寂しい。
しばらく歩いて死んだ魚の目をした後輩に逢い、プロジェクトの雰囲気が暗いことについて質問した。
後輩は、あたりをはばかる低声で、わずか答えた。

「PMは、Excelの仕様書に『変更管理記録』タブを作って変更履歴を記入させます。」
「なぜWikiを使わんのだ。」
「PMは生粋のSIerなのです。社内LANに公開して、良くわからん奴に勝手に編集されても困る、というのですが、誰もそんな、悪心を持っては居りませぬ。」
「SCMのコミットログはどうした。」
「そんなもん信用できん、というのです。PMはVSS以外のSCMを信ずることができないのです。」
「おどろいた。PMは乱心か。」
「いいえ、乱心ではございませぬ。OSSを、信ずる事が出来ぬ、というのです。このごろは、プロジェクトで使っているRedmineも、お疑いになり、少しトラブルが起きるたびに、新たな管理台帳を一つ差し出すことを命じて居ります。御命令を拒めば社内会議にかけられて、強制されます。今月は、管理台帳が３つも増えました。」

@は怒り心頭に達した。
「呆あきれたPMだ。生かして置けぬ。」

という義憤に駆られてRedmineプラグインを書きました。
Wiki Comments Hook Plugin

これはなに？

RedmineのWikiを保存する際にコメントを所定の書式で入力することで、チケットにリンクさせます。
Bitnami::Redmine v1.3.0-1で確認しています。

インストール

Redmineのvendor/pluginフォルダにcloneしてRedmineを再起動してください。

> cd %REDMINE_HOME%\vendor\plugin
> hg clone https://bitbucket.org/fumito_ito/redmine-wiki-comments-hook redmine_wiki_comments

使い方

RedmineのWikiを保存する際に、以下の書式でコメントを入力してください

refs #xxx, #xxx #xxx and xxx 例の件をWikiに反映しましたー。
  • xxxはチケット番号です。
  • #はあってもなくても構いませんが、#があるとリンクされるのでなるべくつけましょう
  • チケットの区切り文字は半角スペース、カンマ、andのいずれかです。

http://gyazo.com/211f37d3d5d4fff1c9446a577083463c.png

こんな感じで反映されます。
http://gyazo.com/e5d3a03351099ed68349f8ef4617cd97.png

なぜ作ったか？

WikiってなんでExcelにかわるようなドキュメントになれないんだろう？と考えたときに
「チケットと簡単に紐付けられないからじゃね？」と思ったからです。

Excelに書いてコミットコメントでチケットに紐付けるほうがトレーサビリティが高いわー、
というのが以前からあって。でもExcelの仕様書もうやだわー、というのも以前からあって。
その葛藤から生まれました。

ライセンス

MIT License

その他

激怒の件はフィクションです。