chore: expose jest coverage reports for CI runs @W-14785065 #3939
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
wjhsf
commented
Jan 10, 2024
Comment on lines
+75
to
+77
| # 1. Remove leading/trailing "border" lines from output | ||
| # 2. Wrap file names in backticks | ||
| # 3. Convert leading whitespace to non-breaking to approximate plaintext output |
There was a problem hiding this comment.
This is just trying to bludgeon the CLI output into a passable markdown table. Happy to consider alternative bludgeoning.
There was a problem hiding this comment.
This is an impressively gnarly sed command, but it's not a big deal since this is only for CI. If we really wanted to improve the code for this, though, we might:
- Use the
jsonreporter - Write our own
.jsscript to process it and print out markdown - (Ideally) apply it to the Karma tests too, since they use Istanbul as well and I'm sure it can be configured to output JSON
That said, that might be over-engineering for this feature. It's just great to see the coverage report in the GitHub UI!
nolanlawson
reviewed
Jan 10, 2024
| // Jest's default reporters are [clover, json, lcov, text]. We add the second text reporter to | ||
| // use the output as the step summary when running tests in GitHub Actions. (Ideally, we'd use | ||
| // a markdown reporter, but there don't seem to be any...) | ||
| coverageReporters: ['clover', 'json', 'lcov', 'text', ['text', { file: 'coverage.txt' }]], |
There was a problem hiding this comment.
I took a look at using the html reporter instead, but it only seems to give a high-level directory overview rather than per-file (unless you want to deeply traverse into HTML files). So yeah, text seems most convenient here.
nolanlawson
approved these changes
Jan 10, 2024
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.
Details
This adds the jest coverage summary to the GitHub Actions job summary and exposes the full coverage reports as artifacts.
Does this pull request introduce a breaking change?
Does this pull request introduce an observable change?
GUS work item
W-14785065