Development Process

This section describes how to get involved in the Jira Plugins project and guidelines for development.

Get project access

Send a mail to one of the Project Admins and ask to be added as commiter to the project. Also give a short description of why :)

Maven

Project uses Maven to build project site and plugins. You must learn the basics if you haven't used it before. We use Maven 1.X! After having installed Maven, you must install som additional Maven plugins from SourceForge. They are used when building sites. Install plugins from project root with: 

maven install-plugins

Write your plugin(s)

All plugins are to be added under the "plugins" folder in CVS. Use the Plugin Template when adding a new plugin. In the template you should replace all instances of "myplugin" (ignore case). Also see the Version plugin for examples.

CVS

ALL CVS commits should have a comment! Avoid commiting stuff that breaks the site build. Work on a branch if you have to. Branches/tags should be named after these rules:

  • BRANCH_JIRA_PLUGINS_<plugin>_<version> (example: BRANCH_JIRA_PLUGINS_VERSION_1_0)
  • TAG_JIRA_PLUGINS_<plugin>_<version> (example: TAG_JIRA_PLUGINS_VERSION_1_0)
When releasing a plugin, you should create a matching tag to CVS.

Site build/deploy

Site is builded from root of project (not from plugin root) with: 

maven multiproject
and deploy with (TODO: create a common deploy user?) 
maven site:sshdeploy

Plugin build/deploy

Build plugin from plugin root with: 

maven clean jar:install
and deploy with (TODO: create a common deploy user?) 
maven jar:deploy