atlas-create-jira-plugin

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

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

Basic usage

atlas-create-jira-plugin [options] - Creates an example of a Jira plugin, which you can adapt to suit your own plugin's needs. (Runs mvn jira:create.) Interpreted parameters: artifact-id, group-id, version, package, non-interactive.

Parameters

This shell script supports some interpreted parameters, specified below. All other parameters are passed straight through to Maven.

Explaining the table columns:

  • 'Full Parameter' and 'Shortened' - Some parameters allow you to choose a full or a shortened version of the parameter, others just support the full version.
  • 'Accepts a Value?' - 'Yes' means that you should specify a value in addition to the parameter, e.g. for the 'version' parameter you should specify the version number. 'No' means that the parameter does not accept a value.

Interpreted parameters:

Full Parameter

Description

--artifact-id

Name of the project. This is an identifier for your plugin. It corresponds to the Maven artifactId. If you do not enter this value, the script will prompt you for it. In this case, the script will fail if you do not provide the artifact-id and group-id.

Shortened: -a

--group-id

Identifier for the logical group of artifacts associated with the project. Will be used as the default value for package. Corresponds to the Maven groupId. If you do not enter this value, the script will prompt you for it.

Shortened: -g

--version

Version of your plugin. Default is 1.0-SNAPSHOT. If you do not enter this value, the script will prompt you for it.

Shortened: -v

--package

Name of the Java package that will contain the plugin source code. Default is the value given for group-id.

Shortened: -p

--non-interactive

If this parameter is present, interactive mode is turned off, so that the script will not prompt the user for input.

--non-interactive doesn't accept a value.

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:

1
2
atlas-create-jira-plugin -?
atlas-create-jira-plugin -help

Examples

Let's assume you want to create a new Jira plugin skeleton. Simply open a command window, go to the directory where you want to create the plugin and type:

1
2
atlas-create-jira-plugin

Let's assume you want to create a new Jira plugin by supplying all the necessary information to the script and allowing the package name to be the same as the group ID. Let's assume you do not want the script to prompt you for information. Type:

1
2
atlas-create-jira-plugin --artifact-id myfooplugin --group-id com.mycompany.plugins --version 1.0 --non-interactive

Working with the SDK

Rate this page: