The devops:developmentInfoProvider
module allows Forge apps to send development information to Jira and associate it with an issue.
Supplied development information will be presented in the development panel of the issue it is associated with.
Development information is written and deleted via the Jira Software REST API which can be accessed by Forge apps using the requestJira function.
When a user uninstalls an app, all the data that the app sent to Jira is deleted immediately. If the app is reinstalled, this data won't be added back unless the app resends historical information to Jira.
1 2modules: devops:developmentInfoProvider: - key: my-development-info-provider name: value: My Development Info Provider homeUrl: https://www.my-development-info-provider.com logoUrl: https://www.my-development-info-provider.com/logo.svg documentationUrl: https://www.my-development-info-provider.com/help actions: createBranch: urlTemplate: https://www.my-development-info-provider/branches/create?issueKey={issue.key}&issueSummary={issue.summary}
Property | Type | Required | Description |
---|---|---|---|
key | string | Yes | A key to identify this module. |
name | object | Yes | A human readable name. |
name.value | string | Yes | Min length: 1 Max length: 255 |
homeUrl | string | Yes | URL to the provider's homepage. Min length: 1 Max length: 255 Regex: |
logoUrl | string | No | The logo for the provider, will be displayed in an area 16 by 16 pixels. Min length: 1 Max length: 255 Regex: |
documentationUrl | string | No | Optional URL to documentation about the provider's Jira integration. Min length: 1 Max length: 255 Regex: |
actions | Actions | No | 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. |
Property | Type | Required | Description |
---|---|---|---|
createBranch | Action | No | Action for creating a new branch. The given URL will be used on the Jira issue development panel. The "Create branch" button will redirect the user to the URL. |
Property | Type | Required | Description |
---|---|---|---|
urlTemplate | string | Yes |
Defines the URL template that is used when an action is invoked. The following context parameters are supported: Min length: 1 Max length: 255 Regex: |
Rate this page: