-
Notifications
You must be signed in to change notification settings - Fork 376
Add user Dev WF (PR) Docs #7335
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Build Analysis Specifics | ||
garath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.