QuickBuild2 Documentation
|
Since QuickBuild 3, a two-way solution is provided to integrate with Atlassian JIRA. The integration features:
This page will describe how to integrate JIRA in QuickBuild. On This Page
Basic IntegrationTo enable the integration: 2. Configure JIRA server in your configuration setting tab You can associate a JIRA project with this configuration. This project is used when you want to update issues or release version to JIRA. See details below. After doing these, the issues keys mentioned in commit messages will be hyperlinked: and an issues report tab will be displayed in Build tab: NOTE The issues here will synchronize with JIRA to reflect their latest status. you can also find all related issues from a specified version and view their changes: After configured the JIRA server in the configuration settings, below steps are available to add in your build workflow:
Advanced IntegrationBesides the basic integration, QuickBuild also features:
Update IssuesTo update issues from the commit messages, Update JIRA Issue step should be added to your build workflow. And you need specify one or more issue updater(s) below in the step:
By default, QuickBuild will update issues according to SCM commit messages. Update issues according to SCM commit messagesWhen QuickBuild find any commit commands in the commit message, it will execute these commands to update or progress the issues listed in the commands. NOTE:
Associate SCM user with JIRA userIf you are using LDAP or Single Sign On (SSO) to manage your users for SCM, QuickBuild and JIRA, you need do nothing. Or if you are using the same user name and password for SCM, QuickBuild and JIRA, you also need do nothing. If they are different, you have to:
Customize Commit CommandThe commit command has two types:
The commit commands can be customized in the Update Jira Issue step based on your JIRA workflow definition. Command AttributesA commit command has below attributes, each attribute relates to the field of an issue:
JIRA custom fields are also supported, for custom fields, below format can be used: customfield_10000 or just 10000 here, 10000 is the field id of a custom field. Please reference http://confluence.atlassian.com/display/JIRA/Custom+fields for details about custom field or consult your JIRA administrator for the custom field id. Below we will give some example commit messages to illustrate the commit commands:
You can define common attributes in the Update Jira Issue step so that when updating issues, the attributes can be applied to all of the issues. When an attribute is specified both in commit command and Extra Attributes, the value in commit command will be used. Update issues by a specified JIRA filterThis updater is used to retrieve the issues to be updated from a specified JIRA filter. This filter should be saved by the user defined in configuration JIRA server setting. And you also need specify the workflow action you want to take. Update issues with specified issue keysThis updater is much similar to update issues by filter. You can specify the JIRA keys directly here, or you can input a script here to generate the issue keys to be updated. Update issues corresponding to changeset closed tasksCurrently, this updater can only work with Perforce. If your Perforce job is associated with JIRA issue, QuickBuild will extract the issue keys from those closed jobs and then update the issue status. Release QuickBuild Version to JIRATo release version to JIRA, Release JIRA Version step should be added to your build workflow. And this step will release the build version to the associated project in JIRA. If this version does not exist, QuickBuild will create it automatically. Also, you can define one or more issue provider(s) below to provide the issues which you want to update their 'Fix Version/s' fields:
Resolved/Closed issues found in commit messagesResolved/Closed issues in previous update issue stepsIssues filtered by a specified filterThe filter should be saved by the user defined in configuration JIRA server setting. Issues with specified keysYou can specify the issue keys directly or you can input a script to generate the issue keys. Issues corresponding to changeset closed tasksCurrently, this can only work with Perforce. If your Perforce job is associated with JIRA issue, QuickBuild will extract the issue keys from those closed jobs. Do not update issuesIf you don't want to update the Fix Version/s field, you can use this.
The version can be managed either from QuickBuild or from JIRA: Manage from QuickBuildBy default, the version is managed by QuickBuild, that means you need not define any version for the associated project in JIRA and QuickBuild will automatically create and release the version of this build. Manage from JIRASometimes, you want to manage the versions in JIRA side by yourself and let QuickBuild retrieve the version from JIRA. In this scenario, you just need change your Next Build Version (in configuration settings -> General Setting section) to use next unreleased version from JIRA, and then you will find the next build version will be the first unreleased version you defined in JIRA when go to configuration dashboard. Create Issue from QuickBuildYou may create an issue from QuickBuild by adding a Create JIRA Issue step. A common case is that when build failed, create an issue so that we can track the build from JIRA. Trouble Shooting
|
Integrating QuickBuild with JIRA
You are viewing the current version of this page. (v. 77)