Truly auto coverage badge

[astariul]

🧐 Context

The existing coverage badge is annoying to deal with : people 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 : we simply check it is up-to-date.

🔍️ Description

This PR moves the coverage badge to an external github Gist.

The github actions changes as well :

• On PR, after running the tests, we upload a message in the PR with the coverage results.
• Whenever something is pushed to the 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.

⚠️ Side-effects / Shortcomings

Need to rely on an external Gist.

✅ How this was tested ?

Tested by creating a new repo and ensuring everything works well.

🌱 Checklist

• Perform self-review of my own code
• Comment the code, particularly in hard-to-understand areas
• Update the documentation accordingly to the new code
• Lint / format the code
• Update existing tests / Add new tests
• Tests are passing locally

[github-actions]

Coverage Report

File	Stmts	Miss	Cover
TOTAL	2	0	100%

Tests	Skipped	Failures	Errors	Time
10	0 💤	0 ❌	0 🔥	0.085s ⏱️