Azure Boards Work Items Integration
- Karl Henselin
- Chandresh Patel
Syntax for Azure Boards Work Items
Azure Boards work items are represented as AzureDevOpsProjectName-NUMBER in FlexDeploy. For example, Trial1-10, Denver-2 where Trial1 and Denver are names of Azure DevOps projects. See image below for reference.
FlexDeploy will accept and show Azure DevOps work items as Denver-1, Denver-2 etc.
Preparing for Azure Boards Integration with FlexDeploy
You need to create an OAuth Token for use in FlexDeploy. This token will be entered for Azure DevOps Personal Access Token on Issue Tracking Instance.
Go to Azure Boards and log in as the user you want to use for FlexDeploy to Azure Boards Integration.
Generate a Personal Access Token in Azure Boards following this guide. ​
Choose an expiration date based on your security policies. Shorter expiration dates will require updating the ITS more frequently.
Choose the following OAuth scopes to comment on and change status of issues:
Create Issue Tracking Instance
An Azure Boards instance looks like this.
Property Name | Property Code | Required | Description |
|---|---|---|---|
Azure DevOps Instance URL |
| Yes | Azure DevOps Instance URL (https://dev.azure.com/{organization}) |
Azure DevOps Personal Access Token |
| Yes | Azure DevOps Personal Access Token |
Azure DevOps API Version |
| Yes | Azure DevOps API Version - Supported versions are
|
Configure Folder or Project for Issue Tracking
Configure Azure Boards Issue Tracking Instance on your project or parent folder. Issue Tracking configurations are inherited by sub-folder and projects. This configuration will allow you to integrate Azure Work Items with your builds. See Configure Project for Issue Tracking for more details.
Work Item pattern is optional, if specified his will used to parse commit logs work item numbers. Alternatively, you can just prefix work item numbers with # in commit message.
Optionally configure for Comment and/or Status update after build or deploy execution.
Linking Azure Work Items with FlexDeploy Builds
Now you are ready to link Azure Boards issues with project builds. In order to link
using commit messages, use the format #issue for example, #Denver-1. Or you use Denver-1234 in commit message if Denver- is setup as work item pattern.
manually at build time - just specify work item number(s) on build request form in work items input. Note that # prefix only necessary with commit message.
manually with package - just specify work item number(s) on package configuration.
See Associate Work Items to a Build for more information about linking Work Items to builds.
Examples
Â
- style