[DOCS]: Add portable regression receipt example to results-and-reporting#70
Open
sumit1kr wants to merge 1 commit into
Open
[DOCS]: Add portable regression receipt example to results-and-reporting#70sumit1kr wants to merge 1 commit into
sumit1kr wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds documentation describing a "Portable Regression Receipt" pattern for CI gating using JsonFileReportSink, including a sample JSON artifact illustrating run-level and scenario-level metadata.
Changes:
- Adds a new section to
docs/usage/results-and-reporting.mdexplaining how to usereport.metadataandresult.metadatafor stable regression artifacts. - Provides an example JSON receipt with sample fields.
Author
|
@microsoft-github-policy-service agree |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #63
Adds a "Portable Regression Receipt" section to
docs/usage/results-and-reporting.mdshowing how to use existing
report.metadataandresult.metadatafields to producea stable, diffable CI artifact tied to
JsonFileReportSink.No new Python types introduced — docs only.