This page last changed on Mar 15, 2007 by jnolen.

Requirements

  • You will need to have Maven 2 installed. You can download Maven 2 here.
  • A copy of Bamboo 1.0, either built from source or a binary distribution, so that you can test your plugin when you develop.
  • We strongly recommend that you build with the Bamboo Plugin Development Kit, available here.
  • These instructions assume your IDE is IDEA. You will need to ensure your dependencies are set up correctly if you use any other IDE.

Setting up the project

Inside the Bamboo Development kit, you will need to change the pom.xml file to correctly setup your project. Within this file, you will need to change the following xml elements:

  • <groupId> - this is the group identifier for your plugin. It is typically something similar to a Java package name.
  • <artifiactId> - this defines the file name of your plugin JAR file.
  • <version> - this defines the version of your plugin.
  • <name> - this defines the name of your plugin.
  • <scm> - this defines your source repository URL

Once this is done, you can run the command mvn idea:idea which will download your dependencies (including the bamboo libraries) and build an IDEA project file $MY_PLUGIN_NAME.ipr. To begin development, simply launch the IDEA project file created.

Once IDEA is up, you will also need to modify the file /src/main/resources/atlassian-plugin.xml to give your plugin a name and a plugin key. You should also fill in your plugin meta-data.

That's it, you should now be ready to start coding your Bamboo plugin.


bamboo-plugin-dev-kit.zip (application/zip)
Document generated by Confluence on May 08, 2007 23:47