Build dashboard (Agile and CMMI)

TFS 2018 | TFS 2017 | TFS 2015 | TFS 2013

Important

Excel reports, Reporting Services reports, and SharePoint dashboards are only supported for on-premises TFS. For information on what is supported for VSTS, see Dashboards, charts, & widgets.

TFS 2018 and later versions no longer support native integration with SharePoint products. If you're planning to upgrade to TFS 2018, read About SharePoint integration to learn about the options available to you.

You can use the Build dashboard to obtain an overview of the development activities that are affecting the quality of the builds. Nightly builds are important to software development projects. When builds are not completing successfully or are not passing build verification tests (BVT), the team must fix the problem immediately.

You can use this dashboard to answer the following questions:

- How volatile is the code base?
- How much of the code is the team testing?
- How high is the quality of the builds?
- Is the quality increasing, decreasing, or staying constant?
- Which builds succeeded?
- Which builds have a significant number of changes to the code?

Requirements

Same requirements defined in Project portal dashboards.

Data displayed in the dashboard

The team can use the Build dashboard to monitor the quality of builds and determine whether a member of the team must take specific steps to correct build failures. To learn about the Web Parts that are displayed on the Build dashboard, refer to the illustration and the table that follow.

Build Quality Dashboard

Note

Code coverage and churn charts, reports Step 1 and Step 2, do not appear when the data warehouse for the team project is not available.

Web Part Data displayed Related topic
Step 1 Line chart that depicts the percentage of code that was tested by build verification tests (BVT) and other tests over the most recent four weeks.

Code Coverage Report
Code Coverage
Step 2 Stacked area chart that depicts how many lines of code the team added, removed, and changed in the check-ins before the build within the most recent four weeks.

Code Churn Report
Code Churn
Step 3 List of recent builds and their build status. You can view more details by choosing a specific build. This list is derived from a Team Web Access Web Part.

Recent Builds Web part

Legend:

Build in Progress: Build Not Started

Build Not Started: Build in Progress

Build Succeeded: Build Succeeded

Build Failed: Build Failed

Build Stopped: Build Stopped

Build Partially Succeeded: Build Partially Succeeded
Run, monitor, and manage
Step 4 List of upcoming events derived from a SharePoint Web Part.

Import Events Web part
Not applicable
Step 5 Count of active, resolved, and closed work items. You can open the list of work items by choosing each number. This list is derived from a Team Web Access Web Part.

Project Work Items Web part
Not applicable
Step 6 List of the most recent check-ins. You can view more details by choosing a specific check-in. This list is derived from a Team Web Access Web Part.

Recent Checkins Web part
Manage pending changes

Required activities for tracking builds

For the reports shown in the Build dashboard to be useful and accurate, the team must perform the following activities:

  • Configure a build system. To use Team Foundation Build, you must set up a build system.

    For more information, see Build and Release agents.

  • Create build definitions. You can create several build definitions and then run each of them to produce code for a different platform. Also, you can run each build for a different configuration.

    For more information, see Get started with CI/CD.

  • Define tests to run automatically as part of the build. As part of the build definition, you can define tests to run as part of the build or to fail if the tests fail.

    For more information, see Set up continuous testing for your builds.

  • Configure tests to gather code coverage data. For code coverage data to appear in the report, team members must instrument tests to gather that data.

    For more information, see Run tests in your build process.

  • Run builds regularly. You can run builds at regular intervals or after every check-in. You can create regular builds when you use the schedule trigger.

    For more information, see Build triggers.

    Note

    Although a team member can manually rate a build by using Build Explorer, this rating is not reflected in the Build Quality Indicators report. The build rating appears in the Build Summary report. For more information, see Rate the quality of a completed build and Build Summary.

Monitor builds

The team can use the Build dashboard to monitor the quality of builds and the level of code coverage that they are testing. Ideally, code coverage is high, and code churn is low or falling. Depending on your team goals, code coverage should be 80% to 100%.

You can use the Code Coverage and Code Churn reports to answer the questions that are listed in the following table.

  • Which builds succeeded?

  • Which builds have a significant number of changes to the code?

  • How often are builds succeeding?

  • How volatile is the code base?

  • How much of the code is the team testing?

  • How high is the quality of the builds?

  • Is the quality increasing, decreasing, or staying constant?

    For more information, see Code Coverage and Code Churn.

Project portal dashboards