Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Syntax for Azure Boards Work Items

JIRA issues 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.

  1. Go to Azure Boards and log in as the user you want to use for FlexDeploy to Azure Boards Integration.

  2. Generate a Personal Access Token in Azure Boards following this guide. ​

  3. Choose an expiration date based on your security policies. Shorter expiration dates will require updating the ITS more frequently.

  4. Choose the following OAuth scopes to comment on and change status of issues:

Create Issue Tracking Instances

An Azure Boards instance looks like this.

Supported Azure DevOps API Versions

  • 5.1-preview, 5.2-preview, 5.3-preview, 5.4-preview, 5.5-preview, 5.6-preview, 5.7-preview, 5.8-preview, 5.9-preview,

  • 6.0-preview, 6.1-preview, 6.2-preview, 6.3-preview, 6.4-preview, 6.5-preview, 6.6-preview, 6.7-preview, 6.8-preview, 6.9-preview,

  • 7.0-preview, 7.1-preview.

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. This will used to parse source code commit logs for JIRA Issues, this is explained in next section.

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 Work Items with project builds.

Linking by Commit Messages

Set up your FlexDeploy project’s issue tracking configuration with a work item pattern. The pattern must be Azure Boards Project name + “-”. If your Jira project name is Denver, then you can use Denver-1 in commit message as Denver- would be setup as work item pattern.

Alternative you can always just prefix with # and not work item pattern configuration is necessary. For example include #Denver-1 in commit message and Denver-1 work item will be picked up during build.

Following this pattern, make a commit message.

Push and merge your change.

When you create a build, the work item numbers are pulled from your commits.

Linking by Manual Entry at Project Build Time

If you didn’t remember to put the work item number in your commit, and you are building the project manually, you can enter work item numbers at build time.

The work item number should be Azure Boards Project Name-Number. In this example, it’s Denver-2.

Linking Issues to Project Packages

If you don’t put work item numbers in your commit message and you are working with a package-based project, you can associate work items with packages that will live through its build and deployment lifecycle. Go to the project and package which you wish to link a work item. Edit the package.

Add one or more work item. The dropdown only shows previously linked work items. Type the entire work item key to enter a new one.

Save. Now, builds and deployments of this package will be linked to these work items.

  • No labels