Skip to content

Commit 8033d54

Browse files
committed
finishing up, 1
1 parent 595fcfd commit 8033d54

File tree

2 files changed

+42
-36
lines changed

2 files changed

+42
-36
lines changed

docs/boards/backlogs/connect-work-items-to-git-dev-ops.md

+3-24
Original file line numberDiff line numberDiff line change
@@ -176,36 +176,15 @@ Or, you can select it from the **Links** :::image type="icon" source="media/icon
176176

177177
## Related articles
178178

179-
Learn more about tracking work with work items and developing with Git from these resources:
180-
181-
::: moniker range="azure-devops"
182-
183-
- [Link to work items from other objects](../../notifications/add-links-to-work-items.md)
184-
- [Add work items](add-work-items.md)
185-
- [Git overview](../../repos/git/index.yml)
186-
- [Link GitHub commits and pull requests to work items](../github/link-to-from-github.md)
187-
- [Create your backlog](create-your-backlog.md)
188-
189-
::: moniker-end
190-
191-
::: moniker range=">= azure-devops-2019 < azure-devops"
192179

193180
- [Configure repositories and branches to integrate with work tracking](../../repos/git/configure-repos-work-tracking.md)
194181
- [Configure pipelines to support work tracking](../../pipelines/integrations/configure-pipelines-work-tracking.md)
195182
- [Add work items](add-work-items.md)
196183
- [Git overview](../../repos/git/index.yml)
197-
- [Link GitHub commits and pull requests to work items](../github/link-to-from-github.md)
198-
- [Create your backlog](create-your-backlog.md)
199-
200-
::: moniker-end
201-
202-
::: moniker range="<= tfs-2018"
203-
184+
- [Link GitHub commits and pull requests to work items](../github/link-to-from-github.md)
185+
- [Link to work items from other objects](../../notifications/add-links-to-work-items.md)
204186
- [Add work items](add-work-items.md)
205-
- [Git overview](../../repos/git/index.yml)
206-
- [Create your backlog](create-your-backlog.md)
207-
208-
::: moniker-end
187+
- [Git overview](../../repos/git/index.yml)
209188

210189
Keep in mind that the **Development** section only appears within the web portal work item form. The work item tracking experience and forms that appear in Visual Studio or other supported clients don't display several of the features that are available from the web portal.
211190

docs/pipelines/integrations/configure-pipelines-work-tracking.md

+39-12
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ ms.technology: devops-agile
66
ms.topic: how-to
77
ms.author: kaelli
88
author: KathrynEE
9-
monikerRange: '>= tfs-2018'
9+
monikerRange: '>= tfs-2017'
1010
ms.date: 08/13/2021
1111
---
1212

1313
# Configure pipelines to support work tracking
1414

15-
[!INCLUDE [temp](../../includes/version-vsts-tfs-2018.md)]
15+
[!INCLUDE [temp](../includes/version-tfs-2017-through-vsts.md)]
1616

1717
To support integration and traceability across Azure DevOps services with pipelines, you can configure several options. You can report pipeline status, copy the syntax for status badges, and set up automatic linking of work items to builds and releases.
1818

@@ -70,7 +70,7 @@ The following table summarizes the integration points between Azure Boards and A
7070
:::column-end:::
7171
:::column span="1":::
7272
YAML, Azure DevOps Server 2020 and later
73-
Classic, TFS 2018 and later
73+
Classic, TFS 2017.2 and later
7474
:::column-end:::
7575
:::row-end:::
7676
---
@@ -90,13 +90,14 @@ The following table summarizes the integration points between Azure Boards and A
9090
::: moniker-end
9191
:::row:::
9292
:::column span="2":::
93-
View work items linked to a build or release
93+
View list of work items linked to a build or release
9494
:::column-end:::
9595
:::column span="2":::
9696
Review and open the work items included in a build or release.
9797
:::column-end:::
9898
:::column span="1":::
99-
Azure DevOps Server 2020 and later
99+
YAML, Azure DevOps Server 2020 and later
100+
Classic, TFS 2017.2 and later
100101
:::column-end:::
101102
:::row-end:::
102103
---
@@ -128,6 +129,12 @@ The following table summarizes the integration points between Azure Boards and A
128129
::: moniker-end
129130

130131

132+
## Prerequisites
133+
134+
- To configure the integration options for a Classic release pipeline, you must have permissions to edit the release.
135+
- 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.
136+
- 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.
137+
131138

132139
## Open pipeline settings, build options, or integration options
133140

@@ -167,7 +174,6 @@ This setting isn't available for Azure DevOps Server 2019 or earlier versions.
167174

168175
Open the build pipeline, choose to edit the pipeline, and then choose the **Options** tab.
169176

170-
171177
::: moniker range=">= azure-devops-2019"
172178
:::image type="content" source="media/pipelines-integration/open-classic-build-properties-options.png" alt-text="Screenshot of Classic Build pipeline, Options tab.":::
173179
::: moniker-end
@@ -180,7 +186,7 @@ The Build properties page appears.
180186
::: moniker range=">= azure-devops-2019"
181187
:::image type="content" source="media/pipelines-integration/classic-build-options.png" alt-text="Build properties dialog.":::
182188

183-
For details on each setting, use one of the following links:
189+
For details on each setting, use one of the following links:
184190
- [Build number format](../release/index.md#how-do-i-manage-the-names-for-new-releases)
185191
- [Automatically link work items](#auto-link-work-items-builds)
186192
- [Create work item on failure](#create-work-item-on-failure)
@@ -291,24 +297,39 @@ This feature isn't supported for YAML pipelines in Azure DevOps Server 2019.
291297

292298
:::image type="content" source="media/pipelines-integration/build-view-work-items.png" alt-text="Screenshot of link to view work items linked to build.":::
293299

300+
1. Save your pipeline.
301+
294302
# [Classic Release](#tab/classic-release)
295303

296304
<a id="classic-report-boards" />
297305

298306
::: moniker range=">= azure-devops-2020"
299-
307+
300308
Prior to choosing your integration options, you should set up the release stages as described in [Define your multi-stage continuous deployment (CD) pipeline](../../pipelines/release/define-multistage-release-process.md).
301309

302310
1. Open **Options>Integrations** for the release pipeline as describe in [Release integration options](#classic-release-options).
303311

304-
1. Check the **Report deployment status to Boards** checkbox. Map the **Deployment type** to each stage, or leave **Unmapped**. Select this option if you want to create links to all work items that represent associated changes to the source, when a release is complete.
312+
1. Check the **Report deployment status to Boards** checkbox. Map the **Deployment type** to each stage, or leave **Unmapped**. Select this option if you want to create links to all work items that represent associated changes to the source, when a release is complete. This option must be enabled in order for the work item form [**Deployment**](../../boards/work-items/work-item-deployments-control.md) control to work.
305313

306314
:::image type="content" source="media/pipelines-integration/release-settings-stages-1.png" alt-text="Screenshot of Report deployment status to Boards, Classic release, 5 stages.":::
307315

308316
To view a list of work items linked to the release, choose **Release (old view)** from :::image type="icon" source="../../media/icons/actions-icon.png" border="false"::: **More commands**, and then choose the **Work Items** tab.
309317

310318
:::image type="content" source="media/pipelines-integration/release-pipeline-view-work-items.png" alt-text="Screenshot of link to view work items linked to a release.":::
311319

320+
1. Save your pipeline.
321+
322+
To verify the integration is working, perform the following steps:
323+
324+
1. Link one or more work items to a commit or pull request in Azure Repos Git repository. For details, see:
325+
- [Drive Git development from a work item](../backlogs/connect-work-items-to-git-dev-ops.md)
326+
- [Link to work items from other objects](../../notifications/add-links-to-work-items.md)
327+
1. Run the pipeline.
328+
329+
1. Open one of the linked work items and view the [**Deployment**](../../boards/work-items/work-item-deployments-control.md) control control. 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.
330+
331+
:::image type="content" source="../../boards/backlogs/media/deployments-control/deployment-control-intro.png " alt-text="Screenshot of Work item form, Deployment control.":::
332+
312333
::: moniker-end
313334

314335

@@ -344,7 +365,7 @@ If a build pipeline fails, you can automatically create a work item to track get
344365

345366

346367
> [!TIP]
347-
> The option to **Create work item on failure** is only supported for Classic pipelines.To accomplish this with a YAML pipeline, see the [Create Bug on Release failure](https://marketplace.visualstudio.com/items?itemName=AmanBedi18.CreateBugTask) marketplace extension.
368+
> The option to **Create work item on failure** is only supported for Classic pipelines. To accomplish this with a YAML pipeline, see the [Create Bug on Release failure](https://marketplace.visualstudio.com/items?itemName=AmanBedi18.CreateBugTask) marketplace extension.
348369
349370

350371
<a id="classic-options-integrations" />
@@ -356,6 +377,10 @@ If a build pipeline fails, you can automatically create a work item to track get
356377
For example, here we choose the Bug work item type and specify the Priority and Tags fields and their values.
357378

358379
:::image type="content" source="media/pipelines-integration/create-work-item-failure-yaml.png" alt-text="Screenshot of Create work item on failure in build options.":::
380+
381+
3. Save your pipeline.
382+
383+
To learn the reference name for a field, look it up from the [Work item field index](../../boards/work-items/guidance/work-item-field.md). For custom fields you add through an inherited process, Azure DevOps assigns a reference name based on friendly field name prefixed with *Custom.*. For example, you add a field named **DevOps Triage**, the reference name is Custom.DevOpsTriage. No spaces are allowed within the reference name.
359384

360385
<a id="enable-status-badge" />
361386

@@ -382,6 +407,8 @@ If a build pipeline fails, you can automatically create a work item to track get
382407

383408
:::image type="content" source="media/pipelines-integration/classic-build-status-badge.png" alt-text="Screenshot of classic build properties, status badge section.":::
384409

410+
3. Save your pipeline.
411+
385412
# [Classic Release](#tab/classic-release)
386413

387414
Select this option if you want to display the latest outcome of a stage deployment on an external website.
@@ -506,11 +533,11 @@ See [Speed up testing by using Test Impact Analysis (TIA), Enable Test Impact An
506533
## Related articles
507534

508535
- [Define your multi-stage continuous deployment (CD) pipeline](../release/define-multistage-release-process.md)
536+
- [Link and view work items to builds and deployments](../../boards/work-items/work-item-deployments-control.md)
509537
- [Release pipelines (Classic) overview](../release/index.md)
510538
- [Configure repositories to support work tracking](../../repos/git/configure-repos-work-tracking.md).
511539
- [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/)
512-
- [Link and view work items to builds and deployments](../../boards/work-items/work-item-deployments-control.md)
513-
- [Associate work items to commits](../../boards/backlogs/connect-work-items-to-git-dev-ops.md)
540+
- [Drive Git development from a work item](../../boards/backlogs/connect-work-items-to-git-dev-ops.md)
514541
- [Link to work items from other objects](../../notifications/add-links-to-work-items.md)
515542
- [End-to-end traceability](../../cross-service/end-to-end-traceability.md)
516543
- [Linking, traceability, and managing dependencies](../../boards/queries/link-work-items-support-traceability.md)

0 commit comments

Comments
 (0)