fix(docs): add Codecov badge and always generate VitePress coverage report#168
Merged
fix(docs): add Codecov badge and always generate VitePress coverage report#168
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
This PR fixes an issue where the coverage report link in the README was returning a 404 error after documentation-only deployments. The fix ensures coverage reports are always included in documentation deployments and adds a Codecov badge for quick coverage percentage visibility.
Changes:
- Added Codecov badge to README alongside the existing detailed coverage report link
- Removed conditional gates from the docs workflow so coverage HTML reports are generated on every documentation deployment, not just releases
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Added Codecov badge to the badges row for at-a-glance coverage percentage |
| .github/workflows/docs.yml | Removed if: github.event_name == 'release' conditions from coverage generation steps to ensure coverage is always integrated into deployed documentation |
|
🎉 This PR is included in version 6.38.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Summary
if: github.event_name == 'release'fromdocs.ymlso coverage HTML report is regenerated on every docs deployment, not just releasesCloses #167