Feature #2435

Plugin API to check that a plugin is correctly installed

Added by Eric Davis about 3 years ago. Updated about 1 year ago.

Status:New Start date:2009-01-03
Priority:Normal Due date:
Assignee:- % Done:

0%

Category:Plugin API
Target version:Unplanned
Resolution:

Description

Both Redmine and Engine migrations follow a strict naming convention for plugins. Problem is, depending on the repository script/plugin install might install the plugin to an incorrect directory. This causes several issues including:

  • migrations get named after the wrong plugin
  • Settings get messed up and set incorrectly

I propose adding a check to Redmine::Plugin.register to make sure that the plugin name matches the installation directory.

Example:

# Required to be installed in vendor/plugins/budget_plugin
Redmine::Plugin.register :budget_plugin  

# Requires to be installed in vendor/plugins/embedded
Redmine::Plugin.register :embedded

References:

History

Updated by Eric Davis about 3 years ago

  • Category set to Plugin API
  • Assignee set to Eric Davis

I can implement this, I just wanted to see if anyone had any better ideas other than throwing an error if the directory is incorrect.

Updated by Gerrit Kaiser about 3 years ago

sounds like a good idea. this hit me as well, and the current error message is not exactly clear about things. So a check would be appreciated!

Updated by Eric Davis over 1 year ago

  • Target version set to Unplanned

Updated by Holger Just over 1 year ago

I developed a patch. It is available from the feature branch on http://github.com/meineerde/redmine/tree/2435-check-plugin-name

Eric: Please check if this is enough or if I should extend it somehow.

Updated by Eric Davis about 1 year ago

  • Assignee deleted (Eric Davis)

I am stepping down from working on Redmine. If someone else is interesting in working on this issue, feel free to reassign it to them.

Eric Davis

Also available in: Atom PDF