Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

redmine_studio_plugin

概要

Redmine Studio(Redmine Power が提供する Windows クライアントアプリ)で必要な機能を提供するプラグインです。

機能

  • Reply Button - チケットに「返答」ボタンを追加
  • Teams Button - ユーザー名にチャットを開始する「Teams」ボタンを追加
  • Auto Close - 条件に基づいてチケットを自動クローズ
  • Date Independent - 親チケットの日付を子チケットから独立させる
  • Wiki Lists - Wikiページやチケットの一覧を表示するマクロ
  • Subtask List Accordion - 子チケット一覧にアコーディオン機能を追加
  • Journals List - チケット一覧にコメント履歴を表示
  • Reply Count - チケット一覧に担当者の切り替え回数(返答回数)を表示
  • Children Count - チケット一覧に直下の子チケット数を表示
  • API - Redmine Studio が内部で使用する API 群
    • Plugin API - プラグイン情報を取得
    • Info API - Redmine 環境情報を取得
    • Studio Settings API - 汎用設定を管理
    • Activity Info API - 活動履歴を取得
    • Cache Bundle API - Redmine Studio のキャッシュ更新を 1 リクエストで完結させる一括取得
    • Issues Bulk Write API - 複数チケットの作成/更新を 1 リクエストで完結させる
    • Issues With Extras API - Issue 取得に Redmine Studio 用の追加フィールドを含めて返す
    • Wiki Preview API - Wiki テキストを HTML に変換

対応 Redmine

  • V5.x (V5.1.11 にて動作確認済み)
  • V6.x (V6.1.1 にて動作確認済み)

インストール

Redmine のインストール先はお使いの環境によって異なります。 以下の説明では /var/lib/redmine を使用しています。 お使いの環境に合わせて変更してください。

環境 Redmine パス
apt (Debian/Ubuntu) /var/lib/redmine
Docker (公式イメージ) /usr/src/redmine
Bitnami /opt/bitnami/redmine

1. プラグインの配置

Redmine のプラグインフォルダにて、以下を実行します。

cd /var/lib/redmine/plugins
git clone https://github.com/RedminePower/redmine_studio_plugin.git

2. インストール

以下のコマンドを実行します。 このコマンドは旧プラグインの削除、DB マイグレーション、cron 登録を一括で行います。 必ず Redmine のインストール先のフォルダで実行してください。

cd /var/lib/redmine
bundle exec rake redmine_studio_plugin:install RAILS_ENV=production

3. Redmine の再起動

Redmine を再起動して変更を反映してください。

アップデート

1. 最新版の取得

cd /var/lib/redmine/plugins/redmine_studio_plugin
git pull

2. アップデート

既に適用済みの処理はスキップされるため、 新規インストールと同じコマンドでアップデートできます。

cd /var/lib/redmine
bundle exec rake redmine_studio_plugin:install RAILS_ENV=production

3. Redmine の再起動

Redmine を再起動して変更を反映してください。

Reply Button

チケットに「返答」ボタンを追加する機能です。

  • 「返答」ボタンをクリックすると、最終コメント投稿者が担当者に自動設定される
  • コメントがない場合は、チケット作成者が担当者に設定される
  • メールで返信する要領でチケット上でやり取りができ、チケット駆動型の開発に便利

詳細は docs/reply_button.md をご覧ください。

Teams Button

ユーザー名の横に「Teams」ボタンを追加し、ワンクリックでチャットを開始できる機能です。

  • 「Teams」ボタンをクリックすると、そのユーザーとの Teams チャットが開く
  • チャットにはチケット情報(タイトル、URL、チケット番号)が自動入力される

詳細は docs/teams_button.md をご覧ください。

Auto Close

条件に基づいてチケットを自動的にクローズ(ステータス変更・担当者変更・コメント追加)する機能です。

  • 全子チケット終了時に親チケットを自動クローズ
  • 期限切れチケットを定期的に自動クローズ(cron で毎日 3:00 に実行)
  • プロジェクト、トラッカー、ステータス、カスタムフィールドなど柔軟な条件設定が可能

詳細は docs/auto_close.md をご覧ください。

Date Independent

親チケットの開始日・期日を子チケットから独立させる機能です。

Redmine の「子チケットの値から算出」設定はシステム全体に適用されるため、プロジェクトごとに挙動を変えることができません。 本機能を使うことで、特定のプロジェクトやステータスに応じて連動を制御できます。

  • 特定のプロジェクトで親チケットの日付を独立させる
  • 特定のステータス(例:終了)の場合は連動を維持する

詳細は docs/date_independent.md をご覧ください。

Wiki Lists

Wikiページにチケットやページの一覧を表示するマクロを提供します。

  • {{wiki_list}} - Wikiページの一覧を表形式で表示
  • {{issue_name_link}} - チケットの件名からリンクを生成
  • {{ref_issues}} - 条件に合うチケットの一覧を表示

詳細は docs/wiki_lists.md をご覧ください。

Subtask List Accordion

Redmine の子チケット一覧は、階層が深くなると全体を把握しにくくなります。 この機能は、子チケット一覧を折りたたみ/展開できるアコーディオン形式に変換し、複雑なチケット構造でも必要な部分だけを表示して作業できるようにします。

  • 子チケット一覧の各階層を折りたたみ/展開可能
  • 子チケット一覧の上部に「すべて展開」「すべて収縮」リンクを追加
  • 右クリックメニューから「このツリーを展開」「このツリーを収縮」「この階層をすべて展開」を選択可能

詳細は docs/subtask_list_accordion.md をご覧ください。

Journals List

チケット一覧の表示オプションに「コメント履歴」を追加する機能です。有効にすると、各チケットの行の下にコメント一覧が表示され、レビューのやり取りを一覧で俯瞰できます。

  • チケット一覧と ref_issues マクロの両方で使用可能
  • 各コメント時点のステータスと担当者を表示
  • 各コメントの折りたたみ/展開(Wiki レンダリング対応)
  • カラムヘッダーによるソート、ダブルクリック、右クリックメニューによる操作

詳細は docs/journals_list.md をご覧ください。

Reply Count

チケット一覧に「返答回数」(担当者の切り替え回数)を表示する機能です。返答回数が多いチケットは、要件の認識齟齬やレビュー指摘の多さを示唆する指標として活用できます。

  • 返答回数でソート可能
  • カーソルを合わせると担当者の変更履歴をツールチップで表示

詳細は docs/reply_count.md をご覧ください。

Children Count

チケット一覧に「子チケット数」(直下の子チケット数)を表示する機能です。レビュー指摘やサブタスクの多いチケットを一覧で素早く把握できます。

  • 子チケット数でソート可能
  • カウントをクリックすると、当該チケットを親に持つチケット一覧画面に遷移
  • カーソルを合わせると子チケットの ID と件名をツールチップで表示

詳細は docs/children_count.md をご覧ください。

API

Redmine Studio が内部で使用する API 群です。各 API の詳細はリンク先を参照してください。

API 説明 詳細
Plugin API プラグイン情報を取得 docs/plugin_api.md
Info API Redmine 環境情報を取得 docs/info_api.md
Studio Settings API 汎用設定を管理 docs/studio_settings_api.md
Activity Info API 活動履歴を取得 docs/activity_info_api.md
Cache Bundle API キャッシュバンドルを取得 docs/cache_bundle_api.md
Issues Bulk Write API 複数チケットの作成/更新を 1 リクエストで実行 docs/issues_bulk_write_api.md
Issues With Extras API Issue 取得に Redmine Studio 用の追加フィールドを含めて返す docs/issues_with_extras_api.md
Wiki Preview API Wiki テキストを HTML に変換 docs/wiki_preview_api.md

アンインストール

1. アンインストールコマンドの実行

cron 解除と DB ロールバックを行います。

cd /var/lib/redmine
bundle exec rake redmine_studio_plugin:uninstall RAILS_ENV=production

2. プラグインの削除

プラグインのフォルダを削除してください。

cd /var/lib/redmine/plugins
rm -rf redmine_studio_plugin

ライセンス

GPL v2 License

About

A Redmine plugin bundling UI enhancements (Reply Button, Auto Close, Rally Count, etc.) and integration APIs for the Redmine Studio desktop app.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages