Create a Plugin

To create a Workarea plugin, use the rails plugin new command with a Workarea plugin template. Follow the instructions for using the app template, with the following changes.

  • Use rails plugin new instead of rails new
  • Include the --full option when running rails plugin new
  • Use the path to plugin_template.rb (instead of app_template.rb) as the argument to the --template option

After creating the plugin, edit the gemspec file to set relevant plugin meta data.

Plugins may be developed within their own git repository or as part of an existing repository, such as a host application built on the Workarea platform. If developing the plugin within an existing repository, be sure to change the s.files logic within the gemspec to include only files relevant to the plugin. For example, Dir.glob over a given array of directory globs rather than including all files with git ls-files.