litestar-org / litestar-org/project-template
ci: add Codecov coverage reporting
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 13
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
## Context
`pytest-cov` is already a test dependency. We should publish coverage to Codecov. PR #16 added a `codecov.yml`.
## Proposed tasks
- [ ] Emit `coverage.xml` in the test workflow
- [ ] Add a `codecov/codecov-action` upload step
- [ ] Add `codecov.yml` (targets / thresholds)
- [ ] Add a coverage badge to `README.md`
- [ ] Confirm `CODECOV_TOKEN` availability for the org
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the test workflow and the existing pytest-cov dependency, then inspect the codecov.yml introduced by PR #16. Verify how coverage.xml is produced, how the Codecov action and README.md badge should fit, and whether CODECOV_TOKEN is available; done means all listed coverage-reporting tasks are confirmed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 70/100