Improve coverage badge to be fully automatic #42
Merged
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.
🧐 Context
The existing coverage badge is annoying to deal with : we often forget to run the command to update the coverage badge before pushing, leading to failing tests on the PR, despite the tests passing locally.
This is because the coverage badge is not truly automatic : the github action simply check if the current badge is up-to-date.
🔍️ Description
This PR moves the coverage badge to an external github Gist.
The github actions changes as well :
main
branch, we run the tests and upload the freshly created coverage badge to the external github gist, effectively keeping the coverage badge automatically up-to-date.✅ How this was tested ?
Tested on a dummy repo.
🌱 Checklist