Release Quality dashboard
Summarize
Summary of Release Quality Dashboard
The Release Quality dashboard provides valuable insights into the quality of software releases by summarizing software quality scans and test outcomes. It is specifically designed for product releases and helps identify potential issues that may affect release quality.
Show less
Key Features
- Configuration Requirements: To utilize the dashboard, ensure that pipelines are configured through external tools. This is necessary to display metrics from various data sources.
- Accessing the Dashboard: Navigate to Workspaces > Digital Product Release Workspace, select the releases icon, choose a release from the list, and click the Quality tab (available only for ongoing releases).
- Data Organization: The dashboard is divided into two main sections: Quality metrics and Test results, with options to filter by Build, Artifact, and Package.
Quality Summary Section
This section summarizes scans performed on the pipelines, displaying key metrics such as:
- Vulnerabilities: Total number of security vulnerabilities identified.
- Overall Coverage: Percentage of code covered by test cases.
- Bug Count: Total number of bugs along with average reliability and maintainability ratings.
- Code Smells: Total number of code smells, technical debts, and duplications.
Test Summary Section
This section provides a summary of test results, showcasing metrics including:
- Unit Tests: Total unit tests run, including counts for passed, failed, skipped, and blocked tests.
- Functional Tests: Total functional tests run with similar counts for outcomes.
- Performance Tests: Total performance tests run, including results breakdown.
Key Outcomes
By utilizing the Release Quality dashboard, ServiceNow customers can effectively monitor release quality, identify potential vulnerabilities, and ensure comprehensive test coverage. This enables teams to make informed decisions regarding release readiness and improve overall software quality.
The Release Quality dashboard provides insights into the quality of a release based on the software quality scan summaries and test summaries.
The software quality scan summaries give an overview of the code, highlighting any potential bugs or vulnerabilities that might impact the release. The test summaries provide a comprehensive view of the testing process, including the number of tests executed, passed, and failed.
Configuration required for tracking release quality
The data displayed on the Quality tab is pulled from the pipeline execution, task execution, and their associated test summaries and software quality summaries. You must configure pipelines through the external tools configuration before you can see the metrics from various data sources on the Release Quality dashboard.
For more information, see Integrate external tools from Digital Product Release Workspace.
Access the Release Quality dashboard
To open the Release Quality dashboard, navigate to . Select the releases icon () and then select a release from the Releases list. Select the Quality tab on the release record.
Data in Quality metrics
- Build: This option shows all pipelines for the product associated with the release from the sn_devops_pipeline table.
The Build summary list includes build numbers that represent pipeline executions from the sn_devops_pipeline_execution_list table.
For an active release, Build summary shows all the pipeline executions of the selected pipeline within the past 30 days. For a completed release, Build summary shows pipeline executions up to 30 days before the actual end date of the release.
- Artifact: This option shows all the artifacts data from the sn_devops_artifact table.
The Artifact version list shows all the artifact versions generated within the past 30 days for the artifact. If the artifact's Use latest version option is selected, the semantic versions are listed. For more information on the artifact version, see Manage artifacts in a release.
- Package: This option shows all the artifact versions associated with the latest package. The artifact version data comes from the sn_devops_m2m_artifact_version_package table and the package data comes from the sn_devops_package table. However, if a package is marked as a release candidate, that package is used even if it's not the latest.
- Quality summary section
- The Quality summary section shows you a summary of the scans that are run on the pipelines. The source of data on these widgets is the Software Quality Scan Summary related to Task Execution. This section contains the following metrics:
Table 1. Quality summary section widgets Widget Description Vulnerabilities Total number of security vulnerabilities for the selected build. This data comes from the Vulnerabilities category in the Software Quality Scan Details.
Use the VulnerabilitiesTypeMapping system property to normalize each type of vulnerability, mapping the custom values with the standard values. For more information, see Digital Product Release properties.
Overall coverage Percentage of code covered by your test cases. This data comes from the Coverage (%) category in the Software Quality Scan Details.
If there are multiple software quality summary results, then the percentage isn’t available.
Total number of lines of code and lines covered for all software quality summary results is shown on this widget.
Bug count Total number of bugs and average ratings of reliability and maintainability data for all the software quality summary results. This data comes from the Bugs category in the Software Quality Scan Details.
Code smells Total number of code smells and total number of technical debts and duplications for all the software quality summary results. This data comes from the Code Smells category in the Software Quality Scan Details.
- Test summary section
- The Test summary section shows you a summary of the test run results. The source of data on these widgets is the Test Summary related to Task Execution. The section contains the following metrics:
Table 2. Test summary section widgets Widget Description Unit tests Total number of unit tests run across all task executions in a pipeline execution, including number of tests passed, failed, skipped, and blocked. Functional tests Total number of functional tests run across all task executions in a pipeline execution, including number of tests passed, failed, skipped, and blocked. Performance tests Total number of performance tests run across all task executions in a pipeline execution, including number of tests passed, failed, skipped, and blocked.