Development Tool

The Development Tool module allows an app to send Development Information to JIRA. This development information will be displayed in the development information panel when an issue is viewed.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "modules": {
    "jiraDevelopmentTool": {
      "url": "https://bitbucket.org",
      "application": {
        "value": "Bitbucket"
      },
      "logoUrl": "https://www.atlassian.com/dam/jcr:bd56917e-e361-4f03-b672-9f5ef5b06e80/Bitbucket-blue.svg",
      "capabilities": [
        "commit"
      ],
      "name": {
        "value": "Bitbucket"
      },
      "key": "bitbucket-integration"
    }
  }
}

Properties

application

Type
i18n Property
Required
Yes
Description

The application behind this development tool

Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

Example

1
2
3
{
  "value": "My text"
}

Properties

value
Type
string
Required
Yes
Description

The human-readable default value. This will be used if no translation exists.

i18n
Type
string
Description

The localization key for the human-readable value. Translations for the keys are defined at the top level of the add-on descriptor.

capabilities

Type
[string, ...]
Required
Yes
Description

What development information the tool offers

key

Type
string
Required
Yes
Pattern
^[a-zA-Z0-9-]+$
Description

A key to identify this module.

This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be globally unique.

Keys must only contain alphanumeric characters and dashes.

The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on key and module key. For example, an add-on which looks like:

1
2
3
4
5
6
7
8
{
    "key": "my-addon",
    "modules": {
        "configurePage": {
            "key": "configure-me",
        }
    }
}

Will have a configuration page module with a URL of /plugins/servlet/ac/my-addon/configure-me.

logoUrl

Type
string
Format
uri
Required
Yes
Description

The logo for the development tool, will be displayed in an area 16 by 16 pixels

name

Type
i18n Property
Required
Yes
Description

A human readable name.

Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

Example

1
2
3
{
  "value": "My text"
}

Properties

value
Type
string
Required
Yes
Description

The human-readable default value. This will be used if no translation exists.

i18n
Type
string
Description

The localization key for the human-readable value. Translations for the keys are defined at the top level of the add-on descriptor.

url

Type
string
Format
uri
Required
Yes
Description

A URL to the development tool

actions

Type
Development Actions
Description

Optional actions that can be performed by Jira users, e.g., create branch, etc.

Development actions that can be performed by Jira users.

Each action is optional (unless indicated otherwise). The absence of an action indicates that the action is not supported by the provider.

Properties

createBranch
Type
object
Description

Defines the URL template that is used when an action is invoked. The following context parameters are supported: {issue.key}, {issue.summary}.