Skip to content

Latest commit

 

History

History
828 lines (758 loc) · 33 KB

cross-service-overview.md

File metadata and controls

828 lines (758 loc) · 33 KB
title titleSuffix description ms.subservice ms.custom ms.topic ms.author author monikerRange ms.date
Cross-service overview
Azure DevOps
Learn about how Azure DevOps supports collaboration and integration across all its services.
azure-devops-cross-service
cross-service
overview
chcomley
chcomley
<= azure-devops
10/10/2023

Cross-service overview

[!INCLUDE version-lt-eq-azure-devops]

Azure DevOps lets you connect to and collaborate across its core services. You can use various features to link and track your devops tasks across Azure Boards, Azure Repos, Azure Pipelines, and Azure Test Plans. This article shows you options for how to use the cross-service integration of Azure DevOps to improve your workflow and productivity.

Links to more information:

Collaboration across Azure DevOps

The following table summarizes some of the features that help you work with your team and other teams.

:::row::: :::column span="1"::: Feature :::column-end::: :::column span="3"::: Description :::column-end::: :::row-end:::

:::row::: :::column span="1"::: @mentions (add to discussions and comments) :::column-end::: :::column span="3"::: You can @mention a team member or an entire team within a work item form discussion or the comment section of a commit, pull request, or changeset. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: #ID (link to a work item) :::column-end::: :::column span="3"::: To support end-to-end traceability, you can link to work items from commits, pull requests, and changesets. :::row-end:::

:::row::: :::column span="1"::: Teams :::column-end::: :::column span="3"::: Each team gets access to a suite of Agile tools and team assets. These tools let teams work autonomously and collaborate with other teams across the enterprise. Each team can configure and customize each tool to support how they work. For quick navigation, they can favorite repositories, pipelines, and test plans. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Set up alerts :::column-end::: :::column span="3"::: Configure or opt out of personal, team, project, or organization-level alerts. Subscribe to email alerts when changes occur to work items, code reviews, pull requests, source control files, builds and more. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Share summaries by email :::column-end::: :::column span="3"::: - Email a list of work items - Email query items - Send release summaries by email :::column-end::: :::row-end:::

::: moniker range=">= azure-devops-2019" :::row::: :::column span="1"::: Wiki :::column-end::: :::column span="3"::: Embed Azure Boards query results in Wiki. :::column-end::: :::row-end:::

::: moniker-end

Azure Boards - Azure Repos

You can link code changes to user stories and features with different link types. For Git, use Branch, Commit, Pull Request, or Tag. For TFVC, use Changeset or Versioned Item.

:::image type="content" source="media/overview/concept-link-types-repos.png" alt-text="Conceptual image of link types that link work items to Azure Repos objects.":::

The following table summarizes the integration points between Azure Boards and Azure Repos.

:::row::: :::column span="1"::: Feature :::column-end::: :::column span="2"::: Description :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Drive Git development from work item(s) :::column-end::: :::column span="2"::: You can initiate a Git branch or link to Git commits or pull requests and drive your Git development cycle for a work item from within the work item form.
:::column-end::: :::row-end:::

:::row::: :::column span="1"::: Automatically link and transition work items with Git commits
:::column-end::: :::column span="2"::: For a Git repository, you can turn on or off the following options: - Close work items with mentions in commit comments. - Remember user choices for completing work items with pull requests. - Link work items from commit comments. You can also automate linking from commits or pull requests in repo settings. - Commit mention linking: Turn on to link commits to work items with #WorkItemID in commit messages. Turn off when you push a repo from a different account or service. Azure DevOps automatically turns off this feature when you import a repo. - Commit mention work item resolution: Turn on to close work items with Fixes #WorkItemID in commits. - Work item transition preferences: On by default, it remembers each user’s option to complete linked work items with pull requests. You can turn this feature off to discourage users from completing work items with pull requests. When it's off, users have to choose to complete work items for each pull request. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Check for linked work items in a Git branch :::column-end::: :::column span="2"::: Encourage traceability by checking for linked work items on pull requests. :::column-end::: :::row-end:::

::: moniker range="<=azure-devops" :::row::: :::column span="1"::: Auto complete work items with pull requests :::column-end::: :::column span="2"::: When you link a work item to a pull request (PR), you can automatically complete those work items when you successfully complete the PR. The system defaults to your selection for future PRs. :::column-end::: :::row-end:::

::: moniker-end :::row::: :::column span="1"::: View list of code objects a single work item is linked to :::column-end::: :::column span="2"::: You can link work items to code changes, builds, and releases—providing an audit trail of how a feature has been developed :::column-end::: :::row-end::: :::row::: :::column span="1"::: Query for external links :::column-end::: :::column span="2"::: You can query for work items that contain links to branches, commits, pull requests or tags. :::column-end::: :::row-end::: :::row::: :::column span="1"::: Configure branch policies to support work tracking :::column-end::: :::column span="2"::: To ensure that changes to a branch have links to work items, you configure the branch policy for a Git repository in repo settings. Turn on the Check for linked work items option. Choose Required to mandate all pull requests have at least one linked work item in order to be completed. Choose Optional to allow pull requests without linked work items, but warn about it.
:::column-end::: :::row-end:::

Azure Boards - Azure Pipelines

The following table summarizes the integration points between Azure Boards and Azure Pipelines. Several features provide support for end-to-end traceability as user stories and features move through the development cycle. As with Azure Repos, you can link work items to pipeline objects with the following link types: Build, Integrated in build, and Integrated in release.

:::image type="content" source="media/overview/concept-link-types-pipelines.png" alt-text="Conceptual image of link types that link work items to Azure Pipelines objects.":::

:::row::: :::column span="1"::: Feature :::column-end::: :::column span="2"::: Description :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Manually link work items to builds. :::column-end::: :::column span="2"::: ::: moniker range=">= azure-devops-2020" Link work items to builds in the same or other project within the organization or collection. ::: moniker-end ::: moniker range="< azure-devops-2020" Link work items to builds in the same project within the organization or collection. ::: moniker-end :::column-end::: :::row-end::: :::row::: :::column span="1"::: Set integration option to automatically create Integrated in build links to work items linked to a branch, commit, or pull request associated with a pipeline. :::column-end::: :::column span="2"::: Required to populate the Development control with Integrated in build links. The work items or commits that are part of a release are computed from the versions of artifacts. For example, each build in Azure Pipelines is associated with a set of work items and commits. For more information, see Configure pipelines to support integration.
:::column-end::: :::row-end:::

::: moniker range="azure-devops" :::row::: :::column span="1"::: To link work items to builds and releases, choose an option and a branch for a Classic or YAML pipeline, which creates Integrated in build and Integrated in release stage links for work items that are linked to a branch, commit, or pull request. :::column-end::: :::column span="2"::: Required to populate the work item form Development control with Integrated in build links and the Deployment control with Integrated in release stage links when running a Classic or YAML pipeline. For more information, see Configure pipelines to support integration. :::column-end::: :::row-end:::

::: moniker-end ::: moniker range=">= azure-devops-2020" :::row::: :::column span="1"::: Set integration option to automatically create Integrated in release stage links to work items linked to a branch, commit, or pull request associated with a release. :::column-end::: :::column span="2"::: Required to populate Deployment control in work item form with Integrated in release stage links. For more information, see Release pipelines, How do I integrate and report release status?. :::column-end::: :::row-end:::

::: moniker-end ::: moniker range="azure-devops-2020" :::row::: :::column span="1"::: View list of work items linked to a Classic release pipeline :::column-end::: :::column span="2"::: Lists all work items linked to a build or release. :::column-end::: :::row-end:::

::: moniker-end ::: moniker range="azure-devops" :::row::: :::column span="1"::: View and open list of work items linked to a Classic or YAML pipeline. :::column-end::: :::column span="2"::: Lists all work items linked to a release since the previous selected release. Can sort the list by each column.
:::column-end::: :::row-end:::

::: moniker-end :::row::: :::column span="1"::: View list of build or release objects a single work item is linked to :::column-end::: :::column span="2"::: You can link work items to builds and releases—providing an audit trail of how a feature has been built and deployed. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Query for external links. :::column-end::: :::column span="2"::: You can query for work items that contain external links. :::column-end::: :::row-end:::

::: moniker range=">= azure-devops-2020" :::row::: :::column span="1"::: View and quickly navigate to release stages a work item is linked to. :::column-end::: :::column span="2"::: The Deployment control on the work item form shows the stages that the work item is linked to. You can see the status of some runs and open each stage or run by expanding a stage. For more information, see Link and view work items to deployments.
:::column-end::: :::row-end:::

::: moniker-end ::: moniker range="azure-devops-2020" :::row::: :::column span="1"::: Create a work item on failure, optionally set values for a work item field (Classic) :::column-end::: :::column span="2"::: Automatically create a work item and set fields when a build fails. :::column-end::: :::row-end:::

::: moniker-end ::: moniker range="azure-devops" :::row::: :::column span="1"::: Create a work item on failure (Classic or YAML), optionally set values for a work item field (Classic) :::column-end::: :::column span="2"::: Automatically create a work item and set fields when a build fails. For more information, see Build options for Classic pipelines, and Customize pipelines, Create work item on failure.
:::column-end::: :::row-end:::

::: moniker-end ::: moniker range=">= azure-devops-2020" :::row::: :::column span="1"::: Query Work Items task. Ensure the number of matching work items returned from a query is within a threshold. :::column-end::: :::column span="2"::: Use this task to ensure the number of matching items returned by a work item query is within the configured thresholds. For more information, see Query Work Items task, Control deployments with gates and approvals.
:::column-end::: :::row-end:::

::: moniker-end

::: moniker range="<=azure-devops"

Azure Repos - Azure Pipelines

Azure Pipelines provides support for building code stored in Azure Repos, either a Git or Team Foundation Version Control (TFVC) repository. Other repositories that Azure Pipelines supports are listed in Supported source repositories.

The following table summarizes the integration features between Azure Repos and Azure Pipelines. ::: moniker-end

::: moniker range="<=azure-devops" :::row::: :::column span="1"::: Feature :::column-end::: :::column span="2"::: Description :::column-end::: :::row-end:::

::: moniker-end ::: moniker range="<=azure-devops" :::row::: :::column span="1"::: Report deployment status :::column-end::: :::column span="2"::: Indicates the status of a deployment on the Files, Commits, and Branches pages for Git repositories. This feature improves the traceability from code commit to deployment. You can configure the release environments to report deployment status. :::column-end::: :::row-end:::

::: moniker-end ::: moniker range="azure-devops" :::row::: :::column span="1"::: Release status badge
:::column-end::: :::column span="2"::: Post the status of your most recent pipeline build in your repository. :::column-end::: :::row-end:::

::: moniker-end :::row::: :::column span="1"::: Code coverage :::column-end::: :::column span="2"::: Publish and review code coverage results that indicate the proportion of your project's code that is actually being tested. :::column-end::: :::row-end:::

Azure Boards - Azure Repos - Azure Test Plans

Several collaboration scenarios are supported through Azure Boards work item types. As with other work item types, you can use managed queries and the Azure DevOps search function to find and list work items.

Note

Several of these work item types—such as Feedback Request, Code Review Request, Shared Steps, and Shared Parameters—are designed to be created through a specific tool or form. They aren't meant to be created manually. Therefore, they are added to the Hidden Types category. Work item types that are added to the Hidden Types category don't appear in the menus used to add work items.

Also, for the Inherited process model, you can only customize the following work item types: Test Plan, Test Suite, Test Case.

:::row::: :::column span="1"::: Scenario :::column-end::: :::column span="1"::: Work item type :::column-end::: :::column span="3"::: Description :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Request code review :::column-end::: :::column span="1"::: Code Review Request :::column-end::: :::column span="3"::: Tracks information entered into the TFVC New Code Review form. For more information, see Get your code reviewed with Visual Studio. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Provide code review :::column-end::: :::column span="1"::: Code Review Response :::column-end::: :::column span="3"::: Tracks review comments provided by code reviewers in response to a code review request. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Request feedback :::column-end::: :::column span="1"::: Feedback Request :::column-end::: :::column span="3"::: Tracks information entered into a request feedback form. Use the following forms to initiate a feedback request. - Request stakeholder feedback - Get feedback. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Provide feedback :::column-end::: :::column span="1"::: Feedback Review :::column-end::: :::column span="3"::: Lets stakeholders provide feedback based on requests for feedback or by volunteering feedback using the Microsoft Test & Feedback Marketplace extension. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Manual testing :::column-end::: :::column span="1"::: Test Plan :::column-end::: :::column span="3"::: Groups one or more test suites and individual test cases together. Test plans include static test suites, requirement-based suites, and query-based suites. To get started, see Create test plans and test suites. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Manual testing :::column-end::: :::column span="1"::: Test Suite :::column-end::: :::column span="3"::: Groups one or more test cases into separate testing scenarios within a single test plan. Grouping test cases makes it easier to see which scenarios are complete. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Manual testing :::column-end::: :::column span="1"::: Test Case :::column-end::: :::column span="3"::: Defines steps used to validate individual parts of your code to ensure your code works correctly, has no errors, and meets business and customer requirements. You can add individual test cases to a test plan without creating a test suite. More than one test suite or test plan can refer to a test case. You can effectively reuse test cases without having to copy or clone them for each suite or plan. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Manual testing :::column-end::: :::column span="1"::: Shared Steps :::column-end::: :::column span="3"::: Enables sharing steps across several test cases. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Manual testing :::column-end::: :::column span="1"::: Shared Parameters :::column-end::: :::column span="3"::: Enables repeating the same test cases with different data. :::column-end::: :::row-end:::

Test work item types

Work item types that support the test experience are linked together using the link types shown in the following image. These include Tested By/Tests, Test Cases/Shared Steps, and Reference By/References.

Screenshot of the Test management work item types.

You can use the web portal to see the test cases that are defined for a test suite, and the test suites that are defined for a test plan. But, there's no specific link type that connects these objects to each other.

Track bugs

The Bug work item type supports the following integrations that you should be aware of when you're tracking bugs.

:::row::: :::column span="1"::: Scenario :::column-end::: :::column span="3"::: Description :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Create a bug from a testing tool :::column-end::: :::column span="3"::: You can add a bug from Test Runner or the Test & Feedback extension. For more information, see Define, capture, triage, and manage bugs. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Create inline tests linked to bugs or user stories :::column-end::: :::column span="3"::: When your team tracks bugs as requirements, you can use the board to add tests to verify bug fixes or user stories. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Track build information with bugs :::column-end::: :::column span="3"::: The Bug work item form contains System Info, Found in Build, and Integrated in Build, which support tracking code defects found and resolved within pipeline builds. For more information, see Query based on build and test integration fields. :::column-end::: :::row-end:::

::: moniker range=">= azure-devops-2019"

Azure Pipelines - Azure Test Plans

Azure Test Plans is fully integrated with Azure Pipelines to support testing within continuous integration/continuous deployment (CI/CD). You can associate test plans and test cases with build or release pipelines. Add pipeline tasks to pipeline definitions to capture and publish test results. Review test results via built-in progress reports and pipeline test reports. The following table summarizes the integration points between Azure Pipelines and Azure Test Plans.

:::row::: :::column span="1"::: Feature :::column-end::: :::column span="2"::: Description :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Test plans setting :::column-end::: :::column span="2"::: With test plan settings, you can configure the Test Run settings to associate build or release pipelines and Test Outcome settings. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Pipeline test-enable tasks :::column-end::: :::column span="2"::: Specify test-enable tasks within a pipeline definition. Azure Pipelines provides several tasks, including the following tasks, that support a comprehensive test reporting and analytics experience.
- Publish Test Results task: Use to publish test results to Azure Pipelines. - Visual Studio Test task: Use to run unit and functional tests (Selenium, Appium, Coded UI test, and more) using the Visual Studio Test Runner. - .NET Core CLI task: Use to build, test, package, or publish a dotnet application.
For other tasks, see Publish Test Results task :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Run automated tests in build pipelines :::column-end::: :::column span="2"::: Associate test plans with a build pipeline. so that they run with each build. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Associate automated tests with test cases :::column-end::: :::column span="2"::: Associate automated tests with test cases. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Set retention policy for automated test results associated with builds :::column-end::: :::column span="2"::: You can set the test retention policy for automated builds from the Pipelines > Retention page. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Requirements traceability :::column-end::: :::column span="2"::: The Requirements quality widget supports tracking quality continuously from a build or release pipeline. The widget shows the mapping between a requirement and latest test results executed against that requirement. It provides insights into requirements traceability. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Test results trend :::column-end::: :::column span="2"::: The Test results trend configurable widget displays the trend of test results for the selected build or release pipeline. The widget helps you visualize the test trends over a period of time, thereby surfacing patterns about test failures, test duration etc. For more information, see Configure the Test Results Trend (Advanced) widget :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Deployment status :::column-end::: :::column span="2"::: The Deployment status configurable widget shows a combined view of the deployment status and test pass rate across multiple environments for a recent set of builds. You configure the widget by specifying a build pipeline, branch, and linked release pipelines. To view the test summary across multiple environments in a release, the widget provides a matrix view of each environment and corresponding test pass rate. See Associate automated tests with test cases :::column-end::: :::row-end:::

:::row::: :::column span="1"::: View test results in builds and releases :::column-end::: :::column span="2"::: Both build and release summaries provide details of test execution. Review these summaries to assess pipeline quality, review traceability, and troubleshoot failures. Choose Test summary to view the details in the Tests tab. :::column-end::: :::row-end:::

:::row::: :::column span="1"::: Test analytics for builds :::column-end::: :::column span="2"::: Each build summary includes an Analytics tab that hosts the Test analytics report. :::column-end::: :::row-end:::

::: moniker-end

::: moniker range=">= azure-devops-2019"

Dashboards, reporting, and Analytics

Dashboards provide an easy way to monitor progress and status. Teams can add configurable widgets to support their goals. The Analytics service is the reporting platform for Azure DevOps, and replaces the previous platform based on SQL Server Reporting Services. Analytics is optimized for fast read-access and server-based aggregations and provides the following benefits:

  • Analytics widgets that you can add to your dashboards
  • In-context Analytics reports available from select Azure DevOps pages
  • Rollup bars and counts for Azure Boards backlogs
  • Custom reports you can create using Power BI
  • Custom reports you can create using OData queries
  • Support to develop and add your custom Analytics widgets you can add to dashboards

::: moniker-end

You can add the following built-in widgets to your dashboard. They're organized under the service they support. You might find more widgets from the Azure DevOps Marketplace.

[!INCLUDE temp]

::: moniker range=">= azure-devops-2019"

Data available from Analytics

Analytics provides the reporting platform for Azure DevOps. Analytics is generally available for Azure DevOps Services and Azure DevOps Server 2020 and is in preview for Azure DevOps Server 2019.

You can access the following data from Analytics.


:::row::: :::column span="1":::

  **Service**

:::column-end::: :::column span="1":::

  **Data availability**

:::column-end::: :::column span="1"::: Azure DevOps Services
Azure DevOps Server 2020
:::column-end::: :::column span="1":::

  **Azure DevOps Server 2019**  

:::column-end::: :::row-end:::

:::row::: :::column span="1"::: Boards :::column-end::: :::column span="1"::: Widgets
In-context reports
OData Power BI :::column-end::: :::column span="1"::: ✔️
✔️
✔️
✔️
:::column-end::: :::column span="1"::: ✔️

  ✔️   
  ✔️   

:::column-end::: :::row-end:::

:::row::: :::column span="1"::: Repos :::column-end::: :::column span="1"::: None :::column-end::: :::column span="1":::

:::column-end::: :::column span="1":::

:::column-end::: :::row-end:::

:::row::: :::column span="1"::: Pipelines :::column-end::: :::column span="1"::: Test analytics
Pipeline analytics
OData preview :::column-end::: :::column span="1"::: ✔️
✔️
✔️
:::column-end::: :::column span="1"::: ✔️

:::column-end::: :::row-end:::

:::row::: :::column span="1"::: Test Plans :::column-end::: :::column span="1"::: Progress report :::column-end::: :::column span="1"::: ✔️
:::column-end::: :::column span="1":::

:::column-end::: :::row-end:::

:::row::: :::column span="1"::: Artifacts :::column-end::: :::column span="1"::: None :::column-end::: :::column span="1":::

:::column-end::: :::column span="1":::

:::column-end::: :::row-end:::

::: moniker-end

Automation and connectors

Microsoft products support automation or integration with several other applications and services. For more information, see the following articles.

Related articles