The Atlassian Plugin SDK provides a set of shell scripts for creating, installing and building plugins for Atlassian products. This page introduces the SDK.
The Atlassian Plugin SDK makes your life easier by helping you do the following:
And more! And we're continually improving the SDK with new and better features.
The SDK commands are wrappers for the underlying Maven commands. The SDK Maven plugin defines custom Maven goals for performing common plugin development tasks. If you want to run the integration tests - and only the integration tests - you can say:
Similarly, you can run the unit tests in isolation:
You can also install your plugin from the command line, instead of having to browse to the correct page and make several clicks:
You can pass parameters on the command line in the form:
To pass Java parameters in a command, use the parameter, in the following form:
atlas-run-standalone --product confluence --jvmargs '-D<parameter1>=<value> -D<parameter2>=<value>'
If you're working behind a proxy server requiring NTLM authentication, you may find it convenient to use a local authenticating proxy server, such as . You can then set Java HTTP environment variables in your SDK commands to point to the proxy. For example, by using:
-Dhttp.proxyHost=localhost -Dhttp.proxyPort=3128 -Dhttps.proxyHost=localhost -Dhttps.proxyPort=3128 -Dhttp.nonProxyHosts=localhost|127.0.0.*
To run the SDK commands where your Java programs don't have direct access to the Internet, your atlas commands should be run with the flag. This disables Google web requests during the build process.
The table below shows the applications currently supported by the Atlassian Plugin SDK, the default port, and the product key for each host application.
Caveat for JIRA: Plugins developed for versions of JIRA before 4.0 are supported, but using the SDK with versions of JIRA earlier than 4.0 is not. For developing plugins for JIRA 3.13 and earlier, take a look at the JIRA Documentation Archives.