GitHubにView customizeプラグインによるRedmineのカスタマイズ事例集を公開しました!


杠です。私は電車通勤をしていますが、最近は本を読むことが多くて外の景色を見ていないことに気づきました。紅葉の時期なのでたまには景色の変化を見てリフレッシュしようと思います。

今回は、View customizeプラグインによるRedmineのカスタマイズ事例をGitHubに公開したことについて、大変だったことや良かったことを交えて書きます。

弊社が提供しているRedmineクラウドサービス「My Redmine」ではRedmineの画面をカスタマイズできるView cusotmizeプラグインを利用できます。View cusotmizeを使ったカスタマイズ事例(設定内容など)を弊社のwebサポート窓口のWikiで紹介していましたが、それをGitHubへ公開しました。

(過去のブログで、View customizeプラグインを紹介しています。「Redmineの画面カスタマイズに便利なView customize plugin」)

View customizeプラグインによるRedmineカスタマイズ集

ファーエンドテクノロジーによるView customizeプラグインによるRedmineカスタマイズ集

GitHubへ公開することになったきっかけ

初めに書いたように、これまでは弊社のwebサポート窓口にカスタマイズ事例を公開していました。しかし、webサポート窓口のアカウントをお持ちのMy Redmineのお客様しかご覧頂けないことや、「どのRedmineバージョンでテストをしたか分からない」、「My Redmineで提供している最新のRedmineバージョンで動くか分からない」というようにカスタマイズの事例を管理できていないという課題がありました。

そこでMy Redmineで提供しているRedmineのバージョンで動作するかを確認し、合わせてカスタマイズを誰でも見られる・社内でも管理しやすくなるようにGitHubへ公開することにしました。


GitHubに公開したカスタマイズ事例の一覧

公開までの流れ

次の手順で作業しました。

  1. GitHubに公開するカスタマイズを選定
  2. カスタマイズがMy Redmineで提供中のRedmineバージョンで動作するか確認
  3. GitHubのプライベートリポジトリでREADMEやカスタマイズ事例を追加 (動作するRedmineのバージョンを記載)
  4. プライベートリポジトリの内容を会社のリポジトリへpushして公開
  5. 社内のナレッジを共有するWikiにカスタマイズ事例の追加手順をまとめる

カスタマイズ事例は、READMEが見やすいようディレクトリ(customizes)にまとめました。


カスタマイズの記事にはテストしたRedmineのバージョンを記載するようにした

ふりかえり

大変だったこと

カスタマイズをRedmineのバージョンごとに動作確認する作業が大変でした。 多くカスタマイズ事例があるのは良いことなのですが、後々管理するときのことも考えてどのバージョンで動作するか確認しておけば良かったと反省しました。バージョンアップがあった時にまた動作確認の作業が必要になるので、できるだけ作業が楽になるような方法を考えなければなと感じました。

良かったこと

カスタマイズの設定内容などは、Markdownで書いていたのでそのまま内容をコピーしGitHubへ掲載できるので書き方を変えるような作業はありませんでした。思ったより時間をかけず作業できて良かったです。

また、これまでカスタマイズ事例は限られた人しか見ることができませんでしたが(弊社のWebサポート窓口のアカウントをお持ちのお客様のみ)、GitHubに公開することで誰でも見られるようになりました。

また、運用面では記事の公開手順をまとめたことで、記事に修正が必要な場合も社内で対応しやすくなったと思います。

webサポート窓口(wiki)
GitHub
Markdownで書いたwebサポート窓口のwikiの記事をそのままコピーしGitHubへ掲載

まとめ

2018年4月ごろからwebサポート窓口のwikiにカスタマイズを追加していって現在では50個ほどになりました。GitHubへ公開しているものは現時点で13個です。現在はwebサポート窓口の方に多くのカスタマイズ事例がありますが、GitHubへ移動していく予定です。GitHubのカスタマイズ追加と合わせて、動作確認の方法や手順を試行錯誤しながら考えていきたいと思います。

「これからview customizeプラグインを使ってみようかな」という方はカスタマイズ事例集を参考にしてみてください!
View customizeプラグインによるRedmineカスタマイズ集


My Redmine

こちらの記事もオススメです!
Redmineの画面カスタマイズに便利なView customize plugin
View customize pluginで簡単にRedmineの画面をカスタマイズできます。
Settingクラスを拡張してマイグレーション無しで動くRedmineプラグインを作った
Redmineの用語やメッセージを管理画面で自由に変更できるプラグイン「メッセージカスタマイズプラグイン」を公開しました。
今年の防災訓練は消火器やビルの消防設備について研修しました
避難訓練から防災訓練に名称を変更し、消火器やビルの消防設備について研修を実施しました。訓練を行うことで万一の際に役立ちます。
AWS Fargateで並行処理をした話
AWSのFargateを利用して、RailsのDB作成とマイグレーションを複数サイトで同時実行してみました。
仕事をしながら深圳大学に1ヶ月留学してきた記録
中国の深圳大学に語学留学して、中国語を4週間学んできました。授業の様子と滞在中の生活を紹介。
ファーエンドテクノロジーからのお知らせ(2019/11/13更新)
2019年11月 オライリー本の全冊公開日のお知らせ(もくもく勉強会も同時開催)
ファーエンドテクノロジーが所蔵するオライリー本(全冊)公開日のご案内です。公開日には「もくもく勉強会」も同時開催します。
「FAREND NEWS」2019年第6号 発行
広報紙「FAREND NEWS」2019年第6号を発行しました。弊社サービスの運用・サポートに携わっているスタッフや弊社の取り組みをご紹介します。
Redmineの最新情報をメールでお知らせする「Redmine News」配信中
新バージョンやセキュリティ修正のリリース情報、そのほか最新情報を迅速にお届け