test: [M3-6876] - Improve formatting of GitHub test result comments #11200
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
This reverts commit 868bafb.
jdamore-linode
requested review from
dwiley-akamai and
abailly-akamai
and removed request for
a team
|
Coverage Report: ✅ |
coliu-akamai
approved these changes
Nov 1, 2024
coliu-akamai
added
Approved
dwiley-akamai
approved these changes
Nov 1, 2024
Cloud Manager E2E
|
||||||||||||||||||||||||||||
| Project |
Cloud Manager E2E
|
| Branch Review |
develop
|
| Run status |
|
| Run duration | 26m 42s |
| Commit |
|
| Committer | jdamore-linode |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
3
|
Pending
|
2
|
Skipped
|
0
|
Passing
|
445
|
| View all changes introduced in this branch ↗︎ | |
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 📝
This PR makes some slight improvements to our GitHub comment test result formatter script. It improves the formatting of the breakdown showing the number of passing, failing, and skipped tests, adds a customizable title, and changes the "Debugging" heading to "Troubleshooting".
Note that this is a low priority and our separate changes to enable GitHub Comments in CI do not rely on these changes being in place first.
Changes 🔄
Target release date 🗓️
N/A, this is not a high priority at all.
Preview 📷
Passing:
With Failures:
I didn't take any screenshots showing the before state, but the table showing the number of passing, failing, and skipped tests was previously a one liner along the lines of " ❌ N failing tests | 💚 N passing tests | 🔽 N skipped tests", and the "Cloud Manager UI Test Results" heading was not present.
How to test 🧪
You can manually run the
yarn junit:summary <path> --format githubcommand and validate its output, or check out the comments posted to my test PR on my fork: jdamore-linode#25Soon I'll add some links to Jenkins run to the Jira ticket showing how it all fits together.
As an Author I have considered 🤔
Check all that apply