interprism's blog

インタープリズム株式会社の開発者ブログです。

Redmine プラグイン開発テンプレート

github.com

要点

  1. redmine-plugin-docker ダウンロード

  2. Redmine 初期化

    make init git_tag=4.0.9

  3. プラグインの雛形生成

    make plug-new name=my_plugin

補足

必要なもの

(bash,) make, git, docker, docker-compose, docker-sync

構成と使い方

README に最低限書きました.

make コマンドをいくつか紹介します.

  • init {git_branch | git_tag | git_commit}=:

    初期化. Redmine ソースを git-clone, Docker イメージのビルド, その他インストール処理を含む. Redmine のバージョンを git-commitish で指定.

  • reinit:

    再初期化. 最初の初期化の後, 手動で変更した, Redmine のバージョンや, Docker 関連の構成を反映.

  • up:

    コンテナ起動, docker-sync コンテナ起動を含む.

  • down:

    コンテナ削除, docker-sync コンテナ削除を含む.

  • bundle-exec cmd=:

    Redmine コンテナで bundle exec コマンド実行. コマンドを cmd= で指定, 例えば, make bundle-exec cmd="runner hello.rb" は bundle exec runner hello.rb を実行.

  • rake task=:

    Redmine コンテナで Rake タスク実行. タスクを task= で指定, 例えば, make rake task=log:clear は bundle exec rake log:clear を実行.

  • rails cmd=:

    Redmine コンテナで Rails コマンド実行. コマンドを cmd= で指定.

  • rails-c:

    Redmine の Rails コンソールに接続.

  • rails-s:

    Redmine を開発用サーバーで起動.

  • plug-new name=:

    Redmine プラグインの雛形作成. プラグイン名を name= で指定.

  • plug-new-model plug= model=:

    Redmine プラグイン Model の雛形作成. プラグイン名を plug=, Model 名を model= で指定.

  • plug-new-ctrl plug= ctrl=:

    Redmine プラグイン Controller の雛形作成. プラグイン名を plug=, Controller 名を ctrl= で指定.

お気持ち

業務仕様のプラグイン作成など Redmine に関わる機会が多いのですが

開発用に長く使う環境もあれば, 検証用に細かくバージョンやソースコードを調整して使い捨てる環境が欲しいときがあります.

Docker で環境構築の手間を減らし, make でコマンド文字数を減らすことで, 快適に作業に臨めるようになりました.

ちょっと Redmine 改造したいとか, プラグイン試したいときにご利用ください.

PAGE TOP