Page History
If you require to package the Aspire Confluence Plugin it is necessary to have the Atlassian SDK install. Please follow the next steps in order to download and configure your environment.
1.1 Download Atlassian SDK
to install an earlier version of the SDK for any reason, you will find it on the Atlassian Marketplace
https://developer.atlassian.com/server/framework/atlassian-sdk/downloads/
1.2 Install Atlassian SDK on Windows
To install the Atlassian SDK on Windows please follow the detail of the steps on the official documentation from Atlassian: https://developer.atlassian.com/server/framework/atlassian-sdk/install-the-atlassian-sdk-on-a-windows-system/
1.3 Install Atlassian SDK on Linux or Mac
To install the Atlassian SDK on Linux or Mac please follow the detail of the steps on the official documentation from Atlassian: https://developer.atlassian.com/server/framework/atlassian-sdk/install-the-atlassian-sdk-on-a-linux-or-mac-system/
1.4 Maven and the Atlassian Plugins SDK
It is important to mention Atlassian SDK uses a specific Maven bundled distribution and a set of commands to use the templates and features available by the different platforms. In the following links, you will find more details about this configuration and commands.
...
“Maven is bundled with the Atlassian Plugin SDK, so you do not need to install it manually. Even if you already have Maven on your system, you should use the one bundled with the SDK, since the SDK requires a specific version of Maven. The version bundled with the SDK is already configured for the SDK, so you do not need to specify repositories. The Atlassian Plugin SDK includes a correctly-configured Maven settings.xml file. “
1.5 How to create a plugin for confluence.
For more information about how to write a Confluence plugin, check the following link on the official documentation: https://developer.atlassian.com/server/confluence/writing-confluence-plugins/
...
The following table show some of the common commands used on the development of a Confluence plugin.
Description | Commands |
Creates an example of a Confluence plugin, which you can adapt to suit your own plugin's needs. Runs mvn confluence:create. | atlas-create-confluence-plugin-module |
Packages the plugin artifacts and produces the JAR. Runs mvn package. | atlas-package |
Removes files from the project directory, that were generated during the build. Runs mvn clean. | atlas-clean |
Runs the application in debug mode with your plugin installed. Runs mvn amps:debug | atlas-debug --product confluence |
Every confluence plugin is required to have a set of configuration objects or files. One of them is the atlassian-plugin.xml. Below you will find an extract of the official Atlassian documentation about this component. For additional details on this check the following reference
1.5.1 Atlassian-plugin.xml element
The atlassian-plugin.xml file describes your plugin to Atlassian applications like JIRA or Confluence. For this reason, you'll often see this file referred to as the descriptor. This file describes important elements like your plugin component modules and visual resources that the Universal Plugin Manager (UPM) uses.
1.6 Eclipse Atlassian SDK setup
As mentioned on the section 4.4. Atlassian SDK requires a specific Maven configuration, for this reason in order to setup Eclipse for development purposes it is necessary to execute the following commands in order to generate required dependencies and configuration files. For more information about this, you can access the following link https://developer.atlassian.com/server/framework/atlassian-sdk/put-the-final-polish-on-the-project-in-eclipse/
...
Overview
Content Tools