atlas-create-bamboo-plugin-module

This page describes the shell script atlas-create-bamboo-plugin-module, part of the Atlassian Plugin SDK.

NOTE: There is a specific version of this shell script for each Atlassian application. The shell script described on this page is for Bamboo.

Basic Usage

atlas-create-bamboo-plugin-module [options] – Prompts you for plugin module type and related details, then creates an example of a Bamboo plugin module that you can adapt to suit your own plugin's needs. (Runs mvn bamboo:create-plugin-module.) Passes all parameters straight through to Maven.The script will automatically add the changes to your atlassian-plugin.xml and generate the appropriate Java code.

Parameters

This shell script is a Maven wrapper script. All parameters are passed straight through to Maven.

Supported plugin module types

The plugin module generation scripts are still under development. Currently, only the JIRA script has the full set of modules. All other products contain the applicable common modules, such as REST, web item and servlet. See the list of common modules in the Atlassian Plugin Framework.

Getting Help

The shell script will display some help text if you enter one of the following as the first argument:

  • -?
  • -h
  • help
  • -help
  • --help

For example:

atlas-create-bamboo-plugin-module -?
atlas-create-bamboo-plugin-module -help

Examples

Let's assume you want to add a new plugin module to your existing Bamboo plugin.

  1. Create your plugin (atlas-create-bamboo-plugin) and install it into the application (atlas-run) as usual.
  2. Go to the root directory for your plugin (where the pom.xml is located).
  3. Run this command:

    atlas-create-bamboo-plugin-module
    
  4. Follow the prompts to specify the type of plugin module that you want, and further information required to create the basic module.
  5. The script will added the required module to your atlassian-plugin.xml file.
  6. Where relevant, the script will add the Java classes to your plugin's .java file too.
RELATED TOPICS

Working with the SDK

Was this page helpful?
Powered by Confluence and Scroll Viewport