プロジェクトの概要にREADMEを表示するプラグインを書いた - suer のブログ

この記事はRedmine Advent Calendar jp 2011 11日目の記事となります。

運用寄りの記事も考えましたが、それよりもプログラムを書くのが楽しそうだったので、即興で小さなプラグインを作ってみました。

github だと READMEから始まるファイルがあるときれいに表示してくれます。
私のようなずぼらなプログラマはREADMEって書くのが億劫になるのですが、
あんな風にプロジェクトの顔的存在として表示されるとなると頑張って書きたくなります。

Redmineはプロジェクトにリポジトリを持っているので、githubと同じことができるじゃん！ということで試作してみました。

Redmine1.2が動く環境で確認しています。
リポジトリは git しか確認していません。

リポジトリのトップディレクトリからREADME から始まるファイルを探してきて、プロジェクトの概要ページに表示します。

Redmineが使っているWikiフォーマッタを使用しているのでなんとなくHTMLに整形されます。

また、Markdown プラグインが入っていて、ファイル名が README.markdown の時に限り、markdownフォーマッタを優先的に使用します。

なんだか細いけど、まあなんとか見れます。

こうしてみるとREADMEがプロジェクトの概要として機能して見えますね。
リポジトリから取ってきているのでもちろんバージョン管理されます。
つまり、プロジェクトの概要がバージョン管理されることになります。

READMEにはビルド方法とか動作環境とか書くのでちょっとイメージと違うかもしれませんが、
これはこれでおもしろいのではないかと。

次は@TrinityTさんです。よろしくお願いします。