Redmine Followup 1.2.0¶

This plugin adds a Followup field to issues.

Features¶

• works independent from the due date, as that may be too far in the future(or past) to work properly as a reminder
• adds a new date attribute field called 'followup' to issues
• with a cronjob, open issues that reach their followup date will cause mails to be sent to their assignees(also to members of assigned Groups as of verison 1.2.0)
• only one mail per user with a consolidated table of all issues that reached their followup date per task execution
• can also check for issues that reach their followup date in a certain amount of days
• Roles need to have the permission granted to edit Followup dates to do so(within the Issue Tracking category)
• Mailtext can be adjusted to your needs in the locales, generic text in English and German is provided, Textmarkers are defined for first name, lastname, count of found tickets and how many days in the future was looked for

Requirements¶

• Redmine: Version 6.0.0 or higher
• Ruby: Compatible with Redmine-supported Ruby versions
• Database: Any database supported by Redmine (MySQL, PostgreSQL, SQLite)
• Properly configured mail notifications in the Redmine configuration

Logging¶

The plugin's task logs by default to console

Installation¶

Installation in Docker-container¶

1. clone the repo to the local machine, note down where you saved it (e.g. /opt/redmine-plugins/redmine_followup)
2. mount that directory to your container (following to the last point e.g. /opt/redmine-plugins/redmine_followup:/usr/src/redmine/plugins/redmine_followup), skip if you mounted the complete plugins directory to your container already
3. restart the container, make sure to have the environment variable REDMINE_PLUGINS_MIGRATE set to true, or manually migrate by hopping into the container and execute the task:
   

   bundle exec rake redmine:plugins:migrate RAILS_ENV=production

4. create a cronjob like:
   1. just check for issues, that have their followup date today or in the past:
      

      1 0 * * * docker exec <redmine container name> bundle exec rake followup:remind RAILS_ENV=production

   2. also check for issues, that have their followup date within the next 7 days(number of days flexible):
      

      1 0 * * * docker exec <redmine container name> bundle exec rake followup:remind[7] RAILS_ENV=production

Installation in non-docker instance of redmine¶

1. clone the repo into the plugin folder of your redmine instance
2. run rake task to migrate:
   

   bundle exec rake redmine:plugins:migrate RAILS_ENV=production

3. clear cache and restart:
   

       bundle exec rake tmp:cache:clear RAILS_ENV=production
       touch tmp/restart.txt
   

4. create a cronjob like:
   1. just check for issues, that have their followup date today or in the past:
      

      1 0 * * * cd /path/to/redmine && /path/to/bundle exec rake followup:remind RAILS_ENV=production

   2. also check for issues, that have their followup date within the next 7 days(number of days flexible):
      

      1 0 * * * cd /path/to/redmine && /path/to/bundle exec rake followup:remind[7] RAILS_ENV=production

Deinstallation¶

Removal from Docker-container¶

1. remove the cronjob
2. delete the plugin directory from your host machine
3. remove migrations from database:
   

   docker exec <redmine container name> bundle exec rake redmine:plugins:migrate NAME=redmine_followup VERSION=0 RAILS_ENV=production

4. remove the mount for the plugin if you added it in the installation
5. restart redmine container(automatically when you do task 4 here)

Removal from non-docker instance of redmine¶

1. remove the cronjob
2. remove database tables and entries:
   

   docker exec -u redmine redmine bundle exec rake redmine:plugins:migrate NAME=redmine_followup VERSION=0 RAILS_ENV=production

3. delete the plugin directory:
   

   rm -rf /path/to/redmine/plugins/redmine_followup

4. clear cache and restart:
   

       bundle exec rake tmp:cache:clear RAILS_ENV=production
       touch tmp/restart.txt