GitAuto: Add code coverage ratio to README #429
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.
Resolves #408
What is the feature
Add a code coverage ratio badge to the README to display the current code coverage status of the repository.
Where / How to code and why
README.md
to include the Codecov badge:[![codecov](https://codecov.io/gh/gitautoai/gitauto/graph/badge.svg?token=U4J7V3GTCU)](https://codecov.io/gh/gitautoai/gitauto)
..github/workflows/main-pytest.yml
to include a step that uploads the coverage report to Codecov using thecodecov/codecov-action
. This ensures that coverage data is continuously reported, keeping the README badge accurate and up-to-date.By automating the coverage reporting, we maintain visibility into code quality directly from the repository's README.
Anything the issuer needs to do
No action required.
Test these changes locally