Having recently developed a plugin (Ruby Rake Plugin) for Atlassian’s Bamboo continuous integration (CI) server I thought I would put together a list of tips for those looking to do the same. As there are some great documents provided by Atlassian on how to get started with plugin development I am not going to go into a lot of detail in this area, it is assumed you already messed around a bit with the Plugin SDK.
So to start with there are some things you should learn before beginning:
The entire plugin development kit revolves around it so you need to understand it, have a read over the Maven Reference and add it to your bookmarks.
The first thing I do when coming back to maven is practice the release process, for most developers this is one of the most frustrating and complicated areas of maven so practice it.
Generate a test Java project using the basic archetype, and push it up to your version control site of choice, either bitbucket or github is fine, and work through the development cycle. Make a few changes check them in and then perform a release, this process normally takes me a few goes to get all the settings right in your maven project.
I recommend you use this approach to re-familiarise yourself with the release process after any long breaks as well, this will ensure maven hasn’t change since you last did it, and you don’t make a mess of your plugin project.
Once you have created your plugin project ensure you fill out all the relevant meta information in your maven pom file, as seen in the sample below. In addition to it being a good practice to do so this information can be used by maven plugins you may include in your project in the future.
<description>This is the ruby rake plugin for Atlassian Bamboo.</description> <organization> <name>Mark Wolfe</name> <url>http://www.wolfe.id.au/</url> </organization> <developers> <developer> <name>Mark Wolfe</name> <email>email@example.com</email> </developer> </developers> <licenses> <license> <name>Apache 2</name> <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> <distribution>repo</distribution> <comments>A business-friendly OSS license</comments> </license> </licenses>
The Java Ecosystem
A small part of this ecosystem is downloaded to your system when you run maven to build your plugin, so I recommend you do a little bit of reading on some of them, the ones I have listed below are a few of my favourites. I myself are a big proponent of the old saying “When in Rome, do as the Romans do”, for this reason I will always try and use the libraries which are already in the SDK.
- Google Collections, in my view one of the core libraries which a Java developer should know.
- SLF4J, one of the many logging abstractions which are used in Java projects but the one I tend to prefer.
- Apache Commons Lang, this library has quite a few utility classes for manipulating strings as well as builders for toString and equals methods in classes.
- Spring Framework, most of the Atlassian products are built using this dependency injection framework so it is handy to understand a bit of how this works.
- JUnit, this unit testing framework has been around for a long time for good reason, learn how to use it.
- Mockito, because mocking is a BIG must when building something in a large application so learn this API and ensure it is included in your plugin project from the start.
This is one of the areas which is often left up to the developers themselves to manage so for this reason I typically follow a simple process, especially when I am working on open source projects.
- Before you start write down what you want to achieve, keep things simple and don’t plan world domination at this stage.
- Build a first release focusing on the goals more than the method, the goal is to prove the concept and most important ship it.
- Do some research now that you know what you looking for, read other peoples code and hack on your initial release a bit.
- Delete your code, start the whole thing again, this sounds nuts but your proof of concept code is probably best left behind (see Corey Haines Code Retreat).
- Build a new release from scratch with more of a focus on structure, testing and extensibility, and again ship it.
comments powered by Disqus