We just released the openproject-plugins gem.

The plugin aims to make writing plugins easier. It provides a generator for creating a basic plugin structure and a module that simplifies setting up the plugin Rails engine. Thus, it is also a dependency for many plugins.

Writing a new OpenProject plugin is now as easy as:

  bundle exec rails generate open_project:plugin <plugin name> <target folder>

Just include

  gem "openproject-plugins", "~> 1.0.2"

in the Gemfile.plugins file of your OpenProject installation. Have a look at the README for more details.

We will continuously update the openproject-plugins gem as openproject develops. Expect handy
plugin helpers and a plugin API to ship with this plugin at some time in the future.

To help us with your contributions, have a look at the OpenProject Community contribution page. In case you find bugs, please report them here.

Kudos goes to all members of the finnlabs team, who did a great job at developing this gem and contributing it to the OpenProject Foundation. Thank you all!