Skip to content

Coverage: add detailed report to job summary #655

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 5 commits into from
Aug 23, 2025

Conversation

brianschubert
Copy link
Member

This writes a more detailed coverage report to GitHub Actions' "Job Summary": https://github.blog/news-insights/product-news/supercharging-github-actions-with-job-summaries/

See brianschubert#5 (comment) for an example (click on the badge in the comment)

cc @Daraan @AlexWaygood

Copy link
Contributor

@Daraan Daraan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's great, even adjust the URL of the badge. 🚀Maybe a click for extended report below as an additional addition?

Co-authored-by: Daniel Sperber <github.blurry@9ox.net>
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!!

if: ${{ always() && steps.cov_xml_upload.outputs.artifact-id != '' }}
run: |
run_url="${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}?pr=${{ github.event.pull_request.number }}"
sed -i "1s|^\(!.*\)$|[\1]($run_url)|" code-coverage-results.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is clever!

...maybe a bit too clever 😆 the sed command feels complex enough to me that I worry it's maybe not worth the maintenance burden. But it's definitely cool! And I guess we can just get rid of it if it unexpectedly breaks for whatever reason in the future

@AlexWaygood AlexWaygood merged commit e589a26 into python:main Aug 23, 2025
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants