This documentation relates to QuickBuild 10.0.x
Select here if you are using a different version

Integrating QuickBuild with JIRA Cloud

Version 5 by Steve Luo
on Feb 18, 2020 13:57.


compared with
Current by Steve Luo
on Feb 18, 2020 14:02.


 
Key
These lines were removed. This word was removed.
These lines were added. This word was added.

View page history


There are 7 changes. View first change.

 Since QuickBuild 10, a two-way solution is provided to integrate with Atlassian JIRA Cloud. The integration features:
  
 * Hyperlink the JIRA keys in commit messages to corresponding JIRA Cloud pages
 * Generate an issues report from commit messages
 * Create an issue to JIRA based on a customized step condition
 * View SCM changes for each issue
 * View related builds for each issue
 * View related builds for each project
  
 h2. QuickBuild Side
  
 h3. JIRA Cloud Issue Tracker
  
 To collect the issues information, you need first add JIRA Cloud tracker setting in QuickBuild. The tracker setting can be defined from Configuration settings -> Issue Tracker -> JIRA Cloud:
  
 !tracker-sidebar.png!
  
 Then, fill in the required information:
  
 !jiracloud-settings.png!
  
 The token can be generated from: https://id.atlassian.com/manage/api-tokens
  
 See more about API token at the following page:
  
 https://confluence.atlassian.com/cloud/api-tokens-938839638.html
  
 h3. Jira Cloud Issues Report
  
 After doing these, the issues keys mentioned in commit messages will be hyperlinked:
  
 !jiracloud-overview.png!
  
 and an issues report tab will be displayed in Build tab:
  
 !jiracloud-issues.png!
  
  
 h3. Create Issue Step
  
 You can also create a issue based on build status or any conditions you want by adding a Create Issue Step just like any other steps in configuration workflow.
  
 The only thing we want to mention here is that if you have some custom fields which are required when creating issue, you need specify them in Extra Attributes:
  
 !extra-attributes.png!
  
 The format for extra attributes is JSON, for example:
  
 {code}
 {
  "customfield_10001": "my custom status",
  "customfield_10010": {
  "type": "obj",
  "name": "test"
  }
 }
 {code}
  
  
 h2. Jira Cloud Side
  
 To view project builds, issue related builds or issue related changes in Jira Cloud. First, we need add mappings for Jira Project and QuickBuild configurations.
  
 h3. Add Project Mapping
  
 Go to QuickBuild administration page, and then Plugin Management tab, find Jira Cloud Integration:
  
 !jira-cloud-plugin.png!
  !plugins.png!
  
 add the mappings in the plugin setting:
  
!jira-cloud-settings.png!
  !qb-settings.png!
  
 h3. Install QuickBuild App
  
 In Jira Cloud, open Jira Settings page, click Apps, then Manage Apps:
  
 !jira-cloud-app.png!
  
 From the bottom of the page, there is a link named Settings
  
 !jira-cloud-settings.png!
  
 Click and enable Development Mode so you can install the app not from Atlassian market place.
  
 !jira-cloud-dev.png!
  
 After enable the development mode, you can add QuickBuild integration by uploading app:
  
!jira-cloud-upload.png!
  !upload.png!
  
 The QuickBuild integration URL is:
  
 https://your-quickbuild-server/rest/jiracloud/connect/atlassian-connect.json
  
 Please replace {{your-quickbuild-server}} with your actual server url.
  
 *NOTE* your quickbuild instance should be accessible from internet.
  
 If the installation is successful, you will see QuickBuild listed in the list:
  
  
  
 h3. Project Builds
  
 Go to your project page, you will see QB Builds in the project sidebar:
  
!jira-cloud-sidebar.png!
  !project-sidebar.png!
  
 Click QB Builds will show you the latest builds related to this project:
  
!jira-cloud-project-builds.png!
  !project-builds.png!
  
  
 h3. Issue Builds and Issue Changes
  
 For a specific issue, the integration can also show you the related builds for that issue,
!jira-cloud-issue-builds.png!
  !issue-builds.png!
  
 and related SCM changes:
  
 !jira-cloud-issue-changes.png!
  !issue-changes.png!