Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions Documentation/Projects/Build Analysis/Introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Build Analysis

The Build Analysis Check is a service to improve the Pull Request experience by highlighting build and test information most helpful to .NET developers. Its goal is to make Pull Request results more actionable.

## What does it do?

High-level features include:

- Highlight most important failure information
- Add context by combining information in Azure DevOps and Helix
- Reduce distance to most helpful analysis tools, such as Azure DevOps Test Result History for a particular test or the Helix artifact logs

For more details, see the [specifics](Specifics.md) document.

## How do I get it?

Build Analysis is enabled on a per-repository basis. Contact dnceng to request it be enabled in your repository.

## How do I use it?

Once enabled, a new GitHub check suite will be included in all pull requests. Navigate to the "Checks" tab, then look for the ".NET Helix" suite.

## Frequently Asked Questions

### Is this useful even if my project does not use Helix?

Yes! The Build Analysis result leverages Azure DevOps history and information to provide context and workflow improvements. Though it may bring additional information for Helix-based execution, it is not required.
15 changes: 15 additions & 0 deletions Documentation/Projects/Build Analysis/Specifics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Build Analysis Specifics

The Build Analysis check includes these details:

- Collapse failures of the same name across Jobs and Pipelines to improve discoverability. For example, failures of the same test across multiple operating systems are grouped together.
- Highlight a failure's state in the target branch
- Provide direct links to the most common pages for continuing analysis
- Link to the Azure DevOps build
- Link to the log of the specific step that failed
- Link to the Azure DevOps Test History for the pipeline
- Link to test history of the specific test
- Link to the Helix artifacts produced by a test
- Link to the test execution details

Each Build Analysis page also includes a "was this helpful" link. This allows you to call out specific highlights or lowlights in your experience with the check. This feedback is then used by the Dev WF team to refine the analysis.