Skip to content

feat: add badge for code coverage #722

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.

Sign up for GitHub

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
henryiii merged 2 commits into from
Dec 11, 2025
+6 −1
Merged

feat: add badge for code coverage #722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12c02cb
feat: add badge for code coverage
cyrraz Dec 10, 2025
c2a3765
feat: support gitlab in codecov badge
cyrraz Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,14 +149,15 @@ backports structure with a small typing example.
- Replaces Flake8, isort, pyupgrade, yesqa, pycln, and dozens of plugins
- Includes spell checking
- One of several popular licenses
- An pylint nox target can be used to run pylint, which integrated GHA
- A pylint nox target can be used to run pylint, which integrated GHA
annotations
- A ReadTheDocs-ready Sphinx or MkDocs `docs/` folder and `docs`
dependency-group
- A `tests/` folder and pytest `test` dependency-group
- A dev group for `uv run` integration
- A noxfile is included with a few common targets
- A README
- Code coverage reporting with automatic uploads to Codecov after tests run

#### For developers:

Expand Down
4 changes: 4 additions & 0 deletions {{cookiecutter.project_name}}/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
{%- if cookiecutter.org | lower == "scikit-hep" %}
[![Scikit-HEP][sk-badge]](https://scikit-hep.org/) {%- endif %}

[![Coverage][coverage-badge]][coverage-link]

{%- if cookiecutter.docs == "sphinx" %}

<!-- SPHINX-START -->
Expand All @@ -31,5 +33,7 @@
{%- if cookiecutter.org | lower == "scikit-hep" %}
[sk-badge]: https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
{%- endif %}
[coverage-badge]: https://codecov.io/{{cookiecutter.__ci}}/{{cookiecutter.org}}/{{cookiecutter.project_name}}/branch/main/graph/badge.svg
[coverage-link]: https://codecov.io/{{cookiecutter.__ci}}/{{cookiecutter.org}}/{{cookiecutter.project_name}}

<!-- prettier-ignore-end -->
Loading