Redmineプラグイン導入・開発入門
14 likes18,924 views
2015年10月02日に開催された「第2回Redmineセミナー 〜利用事例紹介とプラグイン入門〜」で講演した資料です。 イベントURL: http://sanin.itradar.biz/news/2015/09/redmine-seminar-2/
Redmineプラグイン導入・開発入門
- 2. 自己紹介 • 株式会社マツケイ 前田 稔 • お仕事 • 官公庁系のシステム開発 • Redmineプラグイン開発
- 5. Q. プラグインって何？
- 8. A. わりとカンタン！
- 10. A. OSSプラグインがある！ ※ 有償プラグインもある（株式会社アジャイルウェアさんが有名） • Redmine本家（英語）から探す • r-labs（日本語）から探す • GitHubから探す
- 16. Q. 探すときのコツは？
- 17. A. OSSプラグインを探すときのコツ • Redmineの機能名（英語）で大まかに検索する • 実現したい動作（英語）で絞って検索する
- 20. Q. 検証に必要なものは？
- 21. A. プラグインの検証に必要なもの • Redmine • Redmineが動作する環境 https://www.vagrantup.com/ http://www.redmine.org/
- 22. Redmine • ソースコードは次のURLからGETできる • SVN: http://svn.redmine.org/redmine/ • Git: https://github.com/redmine/redmine/ • インストール方法は が わかりやすい http://blog.redmine.jp/
- 25. A. プラグインを動かすには • プラグインのREADMEをよく読むこと！ • プラグインのREADMEをよく読むこと！！ • プラグインのREADMEをよく読むこと！！！
- 26. READMEによく書かれていること • RedmineのVersionが X.X系なら動くよ • “redmine/plugins/” にプラグインを配置してね • $ rake redmine:plugins:migrate を実行してね • Redmineを再起動してね • 権限・モジュール設定画面で有効にしてね
- 27. プラグインが動かない場合は… • もう一度 README を確認しよう • プラグイン名とフォルダ名が同じか確認しよう • バグ報告されているか確認しよう
- 31. Q. チュートリアルとかあるの？
- 32. A. チュートリアルはある！ • http://www.redmine.org/projects/redmine/wiki/ Developer_Guide#Plugin-development • http://www.r-labs.org/projects/r-labs/wiki#デベロッパーガイド
- 33. Q. どんなことができるの？
- 34. A. プラグインで実現できること • 画面の特定箇所を拡張できる • 処理の特定箇所を拡張できる • 標準機能をもとに拡張できる • 画面や処理の置き換えもできる
- 35. 画面の特定箇所を拡張できる • 拡張ポイント（Hook）が用意されている • チケット一覧・作成・編集画面 • プロジェクト設定画面 • ユーザ作成・編集・閲覧画面 など他多数
- 36. 処理の特定箇所を拡張できる • 拡張ポイント（Hook）が用意されている • チケットの作成処理の前後 • Wikiの編集処理の後 • フォーラムのメッセージ作成処理の後 など他多数
- 37. 標準機能をもとに拡張できる • コンテンツを追加する仕組みが用意されている • カスタムフィールド • Wikiマクロや権限など他多数 • “redmine/lib/redmine.rb”, “redmine/lib/*/*/.rb” が参考になる
- 40. A. プラグイン開発の流れ • カスタマイズの見当をつけて方針を決めよう • プラグインの雛形をつくろう • 拡張ポイントを使ってカスタマイズしてみる • 標準機能をもとにカスタマイズしてみる • 画面や処理を置き換えてカスタマイズしてみる
- 42. カスタマイズの見当をつけよう • 標準機能で実現できること • 書式指定っぽい仕組みはある • 自動採番はムリ！
- 43. カスタマイズの方針を決めよう • 標準で自動採番はムリ！ • チケットを作成したときに自動で採番する • 標準で書式指定はカスタムフィールドでできる！ • カスタムフィールドを拡張する
- 44. プラグインの雛形をつくろう • プラグインの名前を決めて雛形をつくる $ rails generate redmine_plugin プラグイン名
- 48. 標準機能をもとにカスタマイズしてみる • （例）カスタムフィールドを拡張するには • “redmine/lib/redmine/field_format.rb” の Redmine::FieldFormat::Base を継承する
- 49. 画面や処理を置き換えてカスタマイズしてみる • 画面の置き換え • “redmine/app/views/*/*.html.erb” と 同じ構成にしておけばOK • 処理の置き換え（定義した module を include する） • alias_method_chain, alias_method を使う
- 51. REST API • Redmine上のデータを操作できるAPI • 言語を問わず利用可能 • リファレンス • http://www.redmine.org/projects/redmine/wiki/Rest_api • http://www.r-labs.org/projects/r-labs/wiki/Redmine_REST_API
- 52. Redmineチケット★一括★ • Excelに記載した内容でチケットの作成・更新が 一気にできるREST APIを利用したソフトウェア • ダウンロード • http://www.vector.co.jp/soft/winnt/util/se503347.html
- 53. RedmineAir • Redmineのチケットを付箋アプリのように使える REST APIを利用したソフトウェア • ダウンロード • http://www.r-labs.org/projects/redmineair/wiki/Wiki
- 54. 導入しているプラグイン • Redmine Page Break Macro • https://github.com/hidakatsuya/redmine_page_break_macro • Hide Sidebar • https://github.com/bdemirkir/sidebar_hide • Redmine Serial Number Field • https://github.com/matsukei/redmine_serial_number_field
- 55. Redmine Page Break Macro • WikiをPDF化・印刷するときに改ページできる • Wikiでドキュメント作るときに便利
- 56. Hide Sidebar • Sidebarの表示・非表示を切り替えできる • チケット一覧画面で非表示にすると便利
- 57. Redmine Serial Number Field • チケットに自動で独自書式の採番ができる
- 59. 宣伝
- 60. ご清聴ありがとうございました