Update the name to test-report and add README for report workflow #3864
Conversation
This file contains 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
Signed-off-by: Zelin Hao <[email protected]>
zelinh
requested review from
dblock,
peterzhuamazon,
bbarani,
gaiksaya,
rishabh6788,
jordarlu,
prudhvigodithi,
Divyaasm and
tianleh
as code owners
gaiksaya
reviewed
Aug 10, 2023
src/report_workflow/README.md
Outdated
| @@ -0,0 +1,24 @@ | |||
| #### Generate test-report manifest for each test. | |||
| The input requires a mandatory `test-manifest-path`, `--artifact-paths`, `--base-path`, `--test-type` and `--test-run-id`, optional `--output-path` and `--component` to automatically generate the test-report manifest after testing. | |||
There was a problem hiding this comment.
nit: Add <required> and <optional> in the below table so that all information related to params is in one place
There was a problem hiding this comment.
You can remove this from here and instead add more description what this workflow actually does.
Suggested change
| The input requires a mandatory `test-manifest-path`, `--artifact-paths`, `--base-path`, `--test-type` and `--test-run-id`, optional `--output-path` and `--component` to automatically generate the test-report manifest after testing. | |
| As the name specifies, the test report workflow helps to automatically generate a consolidated report of the tests run at distribution level along with commands to reproduce the error and associated failures. | |
| These tests include integration tests, BWC tests. |
src/report_workflow/README.md
Outdated
| | --base-path | Base paths of testing logs. | | ||
| | --test-type | Type of tests report generates on. | | ||
| | --output-path | Specify the path location for the test-report manifest. | | ||
| | --test-run-id | Specify the unique execution id for the test. | |
There was a problem hiding this comment.
This test-run-id should be equal to the the test runs build number right?
There was a problem hiding this comment.
Yes, this id will be used to retrieve the component yml.
There was a problem hiding this comment.
Can you specify that it should match the test-run-id from already run tests? Seems like you can enter anything which is not right
Codecov Report
@@ Coverage Diff @@
## main #3864 +/- ##
==========================================
+ Coverage 91.62% 91.78% +0.15%
==========================================
Files 186 186
Lines 5633 5633
==========================================
+ Hits 5161 5170 +9
+ Misses 472 463 -9
|
Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: Zelin Hao <[email protected]>
gaiksaya
approved these changes
Aug 10, 2023
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.
Description
Update the name to test-report and add README for report workflow
Issues Resolved
Part of #1274
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.