すえひろがりっっっっ! このページをアンテナに追加 RSSフィード

2011-12-11

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



f:id:suer:20111208120833j:image



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

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

概要

github だと READMEから始まるファイルがあるときれいに表示してくれます。

私のようなずぼらなプログラマはREADMEって書くのが億劫になるのですが、

あんな風にプロジェクトの顔的存在として表示されるとなると頑張って書きたくなります。

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

動作環境

Redmine1.2が動く環境で確認しています。

リポジトリgit しか確認していません。

ソースコード

github で公開しています。

https://github.com/suer/redmine_readme

機能

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

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

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


まとめ

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

こうしてみるとREADMEがプロジェクトの概要として機能して見えますね。

リポジトリから取ってきているのでもちろんバージョン管理されます。

つまり、プロジェクトの概要がバージョン管理されることになります。

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

これはこれでおもしろいのではないかと。

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

スパム対策のためのダミーです。もし見えても何も入力しないでください
ゲスト


画像認証

トラックバック - http://d.hatena.ne.jp/suer/20111211/redmine_readme_plugin