You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The release deployments control shows release information for those work items that have been associated to a Git commit which is part of a build being released. To learn how to associate work items to commits, see [Drive Git development from a work item](../backlogs/connect-work-items-to-git-dev-ops.md).
18
+
One of the main ways Azure DevOps supports traceability is by linking objects. Work items link to Git branches, commits, pull requests, builds, and more. Work item forms provide two controls to show and quickly navigate to
19
19
20
+
21
+
With the **Deployment** control, you can determine at a glance whether a feature or user story has been deployed and to what stage. You gain visual insight into the status of a work item it is deployed to different release environments as well as quick navigation to each release stage and run.
22
+
23
+
As shown in the following image, the **Deployment** control shows release information for two release stages those work items that have been linked to a Git commit or pull request for a release pipeline configured to integrate with Azure Boards.
24
+
25
+
:::image type="content" source="media/deployments-control/deployment-control-intro.png " alt-text="Screenshot of Work item form, Deployment control.":::
26
+
27
+
28
+
## Supported integration scenarios
29
+
30
+
To populate the Deployment control, perform the following steps:
31
+
32
+
1. Define a Classic release pipeline and set up the release stages as described in [Define your multi-stage continuous deployment (CD) pipeline](../../pipelines/release/define-multistage-release-process.md).
33
+
2. Configure the pipeline as described in [Configure pipelines to support work tracking, Report deployment status to Boards](../../pipelines/integrations/configure-pipelines-work-tracking.md#classic-report-boards).
34
+
35
+
3. Link work items to a commit or pull request in Azure Repos Git repository. For details, see:
36
+
- [Drive Git development from a work item](../backlogs/connect-work-items-to-git-dev-ops.md)
37
+
- [Link to work items from other objects](../../notifications/add-links-to-work-items.md)
38
+
4. Run the pipeline.
39
+
<!--- Only manually triggered releases??? -->
40
+
41
+
## Work items and linking
42
+
43
+
Work items linked to a Git repository Branch, Commit, or Pull Request participate in populating the Deployment control.
44
+
45
+
Each work item linked to a git commit or pull request are candidates for
46
+
You can view all links through the work item form **Links** tab.
47
+
48
+
Which work items are linked to?
49
+
- Work items associated with commits in the build will show the status of the release
50
+
- Only work items co-located with the same project where the release pipeline is defined are linked to.
51
+
52
+
:::image type="content" source="../../notifications/media/types-of-work-item-links.png" alt-text="Conceptual image of Git and integrated link types.":::
53
+
54
+
To learn how to associate work items to commits, see [Drive Git development from a work item](../backlogs/connect-work-items-to-git-dev-ops.md) or [Link to work items from other objects](../../notifications/add-links-to-work-items.md?toc=/azure/devops/boards/toc.json&bc=/azure/devops/boards/breadcrumb/toc.json). To view objects linked to a work item, see [View list of links for a work item](#view-link-list).
55
+
56
+
<!---
57
+
### Unsupported scenarios
58
+
20
59
> [!NOTE]
21
-
> The release deployments control currently works with classic release pipelines and with Azure DevOps Server 2020 and Azure DevOps Services (cloud). If your project is customized using a Hosted XML process, you need to update your work item type definitions to display the control. For details, see [Hosted XML process model, Add release deployment support to a work item type](../../organizations/settings/work/hosted-xml-process-model.md#add-support-wit).
60
+
> Support for GitHub.com, GitHub Enterprise Server, and other Git repositories aren't supported.
61
+
62
+
Other scenarios that aren't supported at this time:
63
+
- Work items linked to Team Foundation Version control changesets, shelvesets, or builds aren't supported.
64
+
- Work items linked to a Git pull request which are stored in a different project aren't linked to the release runs.
65
+
- Manual versus scheduled triggers
66
+
-
67
+
Question - can you link to work items in a different project ???
68
+
How to verify correctness for "Link work items to deployments" Mention other work item - pipeline integration settings
69
+
70
+
-->
71
+
72
+
### Deployment control and work item types
22
73
23
-
## Configure release
74
+
By default, the Deployment control appears on the work item forms for User Story (Agile), Product Backlog Item (Scrum), Issue (Basic), Requirement (CMMI), Feature, Epic, Bug, Task, and Test Case work item types. It is automatically enabled for custom work item types you define using the Inherited process. If you don't use the control, you can choose to [Hide from layout](../../organizations/settings/work/customize-process-field.md#hide-a-field-or-custom-control).
24
75
25
-
Configure your release definition to post deployment information to Azure Boards.
76
+
If your project is customized using a Hosted XML process or you need to add it to a custom work item type for an On-premises XML process, you'll need to update your work item type definitions to display the control. For details, see [Hosted XML process model, Add release deployment support to a work item type](../../organizations/settings/work/hosted-xml-process-model.md#add-support-wit).
26
77
27
-
1. Open Pipelines>Releases, choose to edit your release pipeline, then choose **Options>Integrations**.
2. Check the **Report deployment status to Boards** checkbox and choose the stages and deployment types to report.
81
+
- To configure **Pipeline settings** for YAML-defined release pipelines, you must have permissions to edit the build.
82
+
- To configure the integration options for a Classic release pipeline, you must have permissions to edit the release.
83
+
- To link work items to commits and pull requests, you must have your **Edit work items in this node** permissions set to **Allow** for the Area Path assigned to the work item. By default, the Contributors group has this permission set.
84
+
- To view work items, you must have your **View work items in this node** permissions set to **Allow** for the Area Path assigned to the work item.
33
85
34
-
> [!div class="mx-imgBorder"]
35
-
> 
36
86
37
87
## Deployment control
38
88
@@ -48,9 +98,45 @@ When you open the work item, you can see the stages the release is being deploye
To view and navigate to the builds and releases linked to a work item, choose the :::image type="icon" source="../media/icons/icon-links-tab-wi.png" border="false"::: **Links** tab. Links are grouped under their link type and listed in the order they were created. Choose the **State** or **Latest Update** column headings to sort by the column.
108
+
109
+
:::image type="content" source="media/deployments-control/links-list.png" alt-text="Screenshot of Links tab, Integrated in build and Integrated in release stage.":::
110
+
111
+
Links prefaced with the :::image type="icon" source="../../media/icons/required-icon.png" border="false"::: red exclamation mark indicate that the build, release, or other object has been deleted. This is usually due to retention policies which automatically delete these objects after a certain time period has passed.
112
+
113
+
## Unlink work items
114
+
115
+
Once a work item is linked to a commit or pull request, it will continue to show up as part of the release stages. For example, if you have a work item that didn't pass testing criteria, you may want to remove it from the builds and releases.
116
+
117
+
To remove the work item from participating in future builds and releases, delete the link to the most recent commit and pull request. You can do that by opening the **Links** tab for the work item as shown in the previous section.
118
+
119
+
## Query for linked work items
120
+
121
+
You can't query for work items that are included in releases. However, you can create a query for work items with an `External Link Count > 0`. Include other query filters to optimize your search criteria.
122
+
123
+
51
124
## Related articles
52
125
53
-
- [Create a release](../../pipelines/release/define-multistage-release-process.md)
126
+
**Azure Pipelines**
127
+
128
+
- [Define your multi-stage continuous deployment (CD) pipeline](../../pipelines/release/define-multistage-release-process.md)
- [Configure pipelines to support work tracking](../../pipelines/integrations/configure-pipelines-work-tracking.md).
131
+
- [How to retrieve all work items associated with a release pipeline using Azure DevOps API](https://devblogs.microsoft.com/premier-developer/how-to-retrieve-all-work-items-associated-with-a-release-pipeline-using-azure-devops-api/)
132
+
133
+
**Link work items**
54
134
- [Associate work items to commits](../backlogs/connect-work-items-to-git-dev-ops.md)
135
+
- [Link to work items from other objects](../../notifications/add-links-to-work-items.md?toc=/azure/devops/boards/toc.json&bc=/azure/devops/boards/breadcrumb/toc.json)
- [Linking, traceability, and managing dependencies](../queries/link-work-items-support-traceability.md)
138
+
- [Link type reference](../queries/link-type-reference.md)
55
139
140
+
**Process customization**
141
+
- [Hosted XML process model, Add release deployment support to a work item type](../../organizations/settings/work/hosted-xml-process-model.md#add-support-wit)
For details on each setting, use one of the following links:
195
-
-[Build number format](h../release/index.md#how-do-i-manage-the-names-for-new-releases)
195
+
-[Build number format](../release/index.md#how-do-i-manage-the-names-for-new-releases)
196
196
-[Badge enabled](#status-badge)
197
197
-[Automatically link work items](#auto-link-work-items-builds)
198
198
-[Create work item on failure](#create-work-item-on-failure)
@@ -327,11 +327,10 @@ Once we have the list of commits, we enumerate all the work items associated wit
327
327
328
328
329
329
330
-
<aid="class-report-boards" />
330
+
<aid="classic-report-boards" />
331
331
332
332
::: moniker range=">= azure-devops-2020"
333
-
334
-
<aid="auto-link-work-items-releases" />
333
+
335
334
336
335
## Report deployment status to Boards (Classic)
337
336
@@ -380,7 +379,7 @@ If a build pipeline fails, you can automatically create a work item to track get
380
379
381
380
:::image type="content" source="media/pipelines-integration/yaml-pipeline-more-actions-menu-options.png" alt-text="Screenshot of YAML pipeline More Actions menu options.":::
382
381
383
-
1. Choose the branch and scope of interest, and then choose :::image type="icon" source="../media/icons/copy.png" border="false"::: **Copy to clipboard** to copy the image or markdown syntax.
382
+
1. Choose the branch and scope of interest, and then choose :::image type="icon" source="../../media/icons/copy.png" border="false"::: **Copy to clipboard** to copy the image or markdown syntax.
384
383
385
384
:::image type="content" source="media/pipelines-integration/status-badge-yaml.png" alt-text="Screenshot of YAML pipeline status badge.":::
386
385
@@ -391,7 +390,7 @@ If a build pipeline fails, you can automatically create a work item to track get
391
390
392
391
1. Open pipeline **Build properties** as describe in [Build properties](#classic-build-properties).
393
392
394
-
1. Choose :::image type="icon" source="../media/icons/copy.png" border="false"::: **Copy to clipboard** to copy the image or markdown syntax.
393
+
1. Choose :::image type="icon" source="../../media/icons/copy.png" border="false"::: **Copy to clipboard** to copy the image or markdown syntax.
395
394
396
395
:::image type="content" source="media/pipelines-integration/classic-build-status-badge.png" alt-text="Screenshot of classic build properties, status badge section.":::
397
396
@@ -401,9 +400,9 @@ Select this option if you want to display the latest outcome of a stage deployme
401
400
402
401
1. Check the **Enable the deployment status badge** checkbox. And then, select the stages for which you want to display the outcome. By default, all the stages defined for the release are selected.
403
402
404
-
:::image type="content" source="media/pipelines-integration/enable-status-badge-3-stages" alt-text="Screenshot of Classic release enable deployment status badge with three stages selected.":::
403
+
:::image type="content" source="media/pipelines-integration/enable-status-badge-3-stages.png" alt-text="Screenshot of Classic release enable deployment status badge with three stages selected.":::
405
404
406
-
1. Choose :::image type="icon" source="../media/icons/copy.png" border="false"::: **Copy to clipboard** to copy the image or markdown syntax.
405
+
1. Choose :::image type="icon" source="../../media/icons/copy.png" border="false"::: **Copy to clipboard** to copy the image or markdown syntax.
407
406
408
407
:::image type="content" source="media/pipelines-integration/classic-release-status-badge-3-stages.png" alt-text="Screenshot of Classic release enable deployment status badge with three stages that you can copy.":::
0 commit comments