Add badges to README and update workflow#69
Merged
Merged
Conversation
Merge `develop` into `36-add-badges`
Update CI workflow to generate and persist a coverage badge. Adds write permission for repository contents, installs genbadge, outputs an XML coverage report (reports/coverage/coverage.xml), generates badges/coverage-badge.svg, and commits/pushes the badge back to the repo on push events (uses a bot user and commits with "[skip ci]"). This keeps the coverage badge up-to-date from the workflow run.
edvinskis
marked this pull request as ready for review
July 20, 2026 14:34
astoeriko
approved these changes
Jul 21, 2026
| # Reactix – Simulating 1-D reactive transport with differentiable models in JAX | ||
|
|
||
| [](https://pypi.org/project/reactix/) | ||
| [](https://pypi.org/project/reactix/) |
Owner
There was a problem hiding this comment.
This badge for the Python version shows "missing" when rendered (on the 36-add-badges branch):
Where is the information about supported versions read from? What do we need to do to get the correct versions to show?
Collaborator
Author
There was a problem hiding this comment.
This is intentional. The supported Python versions are read from your package metadata once published to PyPI. To get the correct versions to show, we need to make sure that the pyproject.toml is set correctly and that a release is published to PyPI. Also, the coverage badge will render correctly once pushed to develop.
Closed
Collaborator
Author
|
Note: moved to a simplified workflow with Codecov |
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
2 participants
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.
This pull request adds status badges. The main changes include updating the coverage workflow to automatically generate and commit a coverage badge, and adding several informative badges to the
README.md.CI/CD changes:
.github/workflows/coverage.ymlto grant write permissions, enabling the workflow to commit generated badges back to the repository.genbadgefor generating a coverage badge from the coverage XML report.badges/coverage-badge.svg) automatically on push events.README changes:
README.md, including PyPI version, supported Python versions, test status, coverage, license, and documentation links.Closes: