Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Aspire Confluence plugin was built using the Atlassian plugin software developer kit (SDK), which provide a set of applications, templates, and resources to build custom applications which can be managed within the different Atlassian applications like Jira Software, Jira Service Desk, Confluence, Bitbucket Server, and Bamboo. For more information about the Atlassian-SDK access the following link: https://developer.atlassian.com/server/framework/atlassian-sdk/

If you require to package the Aspire Confluence Plugin it is necessary to have the Atlassian SDK installinstalled. Please follow the next steps in order to download and configure your environment.

...

“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. “


Image RemovedImage Added

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/

Confluence offers around 44 different types of plugin modules that you can use to extend the current capability of your application (https://developer.atlassian.com/server/confluence/). In the case of the Aspire Confluence Plugin it includes 7 different modules, 6 of them EventListener modules for Space, Pages, Attachment, Comments, etc.

Image RemovedImage Added


For more information about the Event Listener module, you can review the official documentation in the following link. https://developer.atlassian.com/server/confluence/event-listener-module/

...

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

...

1.6        Eclipse Atlassian SDK setup

As mentioned on the in section 41.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/

...

  1. Select File > Import.
  2. Expand the General folder tree.
  3. Filter for Existing Projects into Workspace and press Next.
  4. Choose Select root directory and then Browse to the root directory of your workspace.
  5. Select your plugin project and click Finish.


Image RemovedImage Added