Last updated Jun 13, 2024

Working in an IDE

Most developers are accustomed to working within an IDE. The getting started tutorial describes how to set up the project in Eclipse in Windows and in Linux. If you are using IntelliJ IDEA, just open the POM in your IDE following Configure IDEA to use the SDK. If you are using NetBeans, see Configure NetBeans to use the SDK.

What's happening

In general, IDEs use the project POM file to generate the resource files it understands to be a development project. When you import an Atlassian Plugins SDK project into an IDE, Maven downloads all of the dependencies referenced in your pom.xml, and then all the inherited dependencies from the parent POMs (unless it has already done so).

Your settings.xml specifies that Maven should download the JavaDoc and source artifacts as well, where available. This is likely to take quite a while. Depending on your plugin's host application, Maven will now download 100MB or more from the internet. Go relax, get some tea or coffee, read a blog. Fortunately, after you've downloaded these files for the first time, they are stored in your local Maven repository ($HOME/.m2/repository/) and need not be downloaded again unless they change.

After this is complete, Maven will construct project files that your IDE can understand. It will reference all the dependent JARs in the right projects, and attach the sources and Javadoc where they are available. Don't forget, when you're ready to check in your plugin, do not commit these project files. They are specific to each IDE and to your specific development environment.

More information

The following pages provide additional information on using the Atlassian Plugins SDK with an IDE:

Rate this page: