Redmine issue assign notice plugin の紹介

第20回redmine.tokyo勉強会で発表した「Redmine issue assign notice plugin の紹介」

1. Redmine issue assign notice plugin の紹介 2021-05-22 第20回redmine.tokyo勉強会 @onozaty
2. 自己紹介 • Hirokazu Onozato • 株式会社ユニスティ所属 • ソフトウエア開発者 • Redmine歴12年くらい • View customizeプラグイン作者 • https://github.com/onozaty/redmine-view-customize @onozaty https://github.com/onozaty
3. 本日のお題 Redmine issue assign notice plugin https://github.com/onozaty/redmine_issue_assign_notice 2020年12月リリース
4. Redmine issue assign notice plugin チケットの担当者が変わったときに、SlackやTeams、Rocket.Chatなど に通知するプラグイン。 • 担当者になったことに、すぐに気づけるようにしたくて作った • 実際に自分が関わるプロジェクトで利用中 • 同じような通知を別の方法で実現していたが、Redmineのプラグインとして置き換えた
5. 本プラグインの特徴 担当者の変更に絞って通知
6. 担当者の変更に絞って通知 • チケットが作成/更新されたら通知するようなプラグインは既に あったが、そのようなプラグインだと、チケットが頻繁に作成/更 新されるようなプロジェクトでは、情報量が多くなりすぎて埋もれ てしまう • 誰も見ない/気がつかないということになりかねない • 一番重要な情報は、自分がそのチケットの担当になったということ なので、担当者の変更に絞った情報を通知するようにした
7. 通知内容 • チケットの担当者が変わった時に、下記のような内容の投稿をして くれる • 1行目: 担当者変更に関する情報 • 2行目: プロジェクト名、トラッカー、チケット番号、題名、ステータス • トラッカー＋チケット番号はリンクになっている • 3行目: チケット新規作成時は説明、チケット変更時は注記(先頭200文字ま で)
8. 通知内容 • メンションも飛ばせる • 自分自身を担当にした際にはメンションは飛ばないようにしている • 自分で変更したということは、既に知っていることなので • TeamsはIncoming Webhookでメンションに対応していないのでメンショ ンできない • メンション用のIDはユーザのカスタム フィールドとして設定
9. 対応している通知先 • 動作することが確認できているのは下記のチャットサービス • Slack • Teams • Google Chat • Rocket.Chat • 利用する機能はIncoming Webhookなので、Incoming Webhookに対 応しているものならば、上記以外でも動くはず • 一部サービスで記法が異なり、プラグイン側でサービスによって分けてい る箇所もあるので、表示が崩れるといったことはあるかも
10. 設定方法 • プラグインの設定画面にて、通知先で発行したIncoming webhook のURLを設定するだけ • 各サービスでのIncoming Webhookの発行方法は下記を参考に • 各チャットツールのIncoming Webhookのまとめ https://zenn.dev/onozaty/articles/chat-incoming-webhooks
11. 設定方法 - その他 • 下記のような設定も可能 • プロジェクト毎に通知先を変更する • メンションの有効/無効化 • 詳しい設定方法などはREADMEを参考に • https://github.com/onozaty/redmine_issue_assign_notice/blob/main/README.ja.md
12. おすすめの運用方法 • 通知先のチャンネルは、専用のチャンネルに • 他の会話と混ざると読みづらい • チャンネルの通知があったときに、プラグインによるものと、通常の会話 によるものとの区別もつきづらくなる • プラグインでのメンションを有効＋チャンネルの通知設定はメン ションのみに • 自分が担当者となったメンションのみが チャンネルの通知となり、他の人が担当者に なったメッセージを気にしないで済む
13. おわりに チケットの担当者を切り替えながら進めていくようなプロジェクトで は、とても有用なプラグインだと思うので、興味を持たれたかたは、 ぜひ一度お試しください。 使ってみて良かったら、リアクションをいただけると、プラグイン作 者としてはうれしいです。 • GitHubのStar • redmine.orgのPlugins DirectoryでのRate • インターネット上(TwitterやBlogなど)でのコメント等 • GitHub SponsorやDonate などなど