Redmine プラグインの開発環境を整える #Redmine - Qiita

書くこと

以前のエントリーでも紹介した Redmine Issue Wiki Journal プラグインを作った際に、 Redmine プラグインの開発環境で試行錯誤したのでそれを紹介します。

Redmine プラグイン開発環境を整える

redmine_issue_wiki_journal を例に説明します。

好きな場所に Redmine プラグインの開発用ディレクトリを用意します。 redmine_plugins とでもしましょうか。

$ mkdir /path/to/redmine_plugins

ここに、プラグインの開発コードを配置します。

$ cd redmine_plugins/
$ git clone git@github.com:hidakatsuya/redmine_issue_wiki_journal.git

まだ github 等でリポジトリを用意していない場合は、 /path/to/redmine_plugins/redmine_issue_wiki_journal/ のような構造で開発するプラグインのコードを配置して下さい。

プラグイン単体ではテストコードの実行も動作テストもできないので Redmine 本体が必要です。私は以下のようにメジャーバージョン単位で Redmine 本体を用意しています。

$ pwd
/path/to/redmine_plugins/
$ git clone https://github.com/redmine/redmine.git 2.3-stable
$ cd 2.3-stable/
$ git checkout -b 2.3-stable origin/2.3-stable
$ git clone https://github.com/redmine/redmine.git 2.2-stable
（以下同様）

そして、それぞれの Redmine 本体で開発中のプラグインが使えるように plugins ディレクトリ以下にシンボリックリンクを張ります。

$ cd 2.3-stable/
$ ln -s /path/to/redmine_plugins/redmine_issue_wiki_journal plugins/
（2.2-stable も同様）

以上です。後は各 Redmine ディレクトリに移動して以下のようにテストコードを実行したり、 rails s で動作テストすれば良いと思います。

$ cd 2.3-stable/
$ rake redmine:plugins:test NAME=redmine_issue_wiki_journal

ディレクトリ構造

まとめるとこんな感じです。

/path/to/
  redmine_plugins/
    2.3-stable/
        :
      plugins/
        redmine_issue_wiki_journal/ 
           -> /path/to/redmine_plugins/redmine_issue_wiki_journal/
    redmine_issue_wiki_journal/

いろいろと端折ってますが参考になれば幸いです。