Rso's Jotter

日々の開発の知見のメモやその他雑記

Redmineのプラグインテンプレートを公開しました

最近、Redmineの簡単なプラグインを開発する機会があったのですが、 プラグイン開発に関する情報を調べるに当たって、以下のガイドを参考にとりあえず動くものは作れるのですが、そこから先の細かな情報がなかなか見つかりませんでした。

guide.redmine.jp

ある程度動作を理解してしまえば、なんとなく動くのが作れるのですが、実際にコントローラフックから 欲しいissueのデータやカスタムフィールド をの値をどうやって取ってこれば良いかなど、さっと調べても情報がなかったので、 pry-byebygで contextの中身を調べたり、他の公開されているOSSのプラグインの中身を調べたりしました。

この調査にちょっとだけ時間がかかったので、またおそらく時間が経つと忘れると思うので、私が調べた内容をテンプレートとしてgithubに上げました。

github.com

githubにも書いていますが、このテンプレートには、以下の内容が含まれます。

  • ビューフックとコントローラフックのサンプル。使用したい部分だけ残して、不要なものを削除すればそのまま使えます。
  • コントローラフックからissueのデータやカスタムフィールド のアクセス、更新のサンプル
  • プラグインの設定画面のサンプルと設定情報の取得方法のサンプル DBは特に変更していないので、 plugins ディレクトリにチェックアウトすればそのまま使えます。

どちらかというと今後の自分のためのいうために残したものですが、もし何かの役に立つようなことがあれば利用いただければ幸いです。