Skip to content
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.

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

GitAuto: Add code coverage ratio to README #429

Merged
merged 2 commits into from
Dec 22, 2024

Conversation

gitauto-for-dev[bot]
Copy link
Contributor

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

  1. Update 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).
  2. Modify .github/workflows/main-pytest.yml to include a step that uploads the coverage report to Codecov using the codecov/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

git fetch origin
git checkout gitauto-wes/issue-408-20241222-191006
git pull origin gitauto-wes/issue-408-20241222-191006

@hiroshinishio hiroshinishio merged commit 45e6575 into main Dec 22, 2024
@hiroshinishio hiroshinishio deleted the gitauto-wes/issue-408-20241222-191006 branch December 22, 2024 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add code coverage ratio to README
1 participant