Summary
Integrate Coveralls into the GitHub Actions CI pipeline to track test coverage over time and surface coverage changes on pull requests.
Motivation
MaveDB currently has no automated coverage reporting. Adding Coveralls will:
- Make coverage regressions visible on PRs before merge
- Track coverage trends alongside ongoing development
- Provide a coverage badge for the repo
Implementation
- name: Run tests
run: pytest --cov=mavedb --cov-report=lcov --cov-report=term-missing
- name: Upload coverage to Coveralls
uses: coverallsapp/github-action@v2
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
path-to-lcov: coverage.lcov
Notes
- Use
lcov format — coverallsapp/github-action@v2 prefers it over XML
- Coverage can be scoped with
--cov=src/mavedb to exclude test files and migrations from the report
- No additional configuration file needed for a standard layout
References
Summary
Integrate Coveralls into the GitHub Actions CI pipeline to track test coverage over time and surface coverage changes on pull requests.
Motivation
MaveDB currently has no automated coverage reporting. Adding Coveralls will:
Implementation
pytest-covandcoverallsto dev dependenciesREADME.mdNotes
lcovformat —coverallsapp/github-action@v2prefers it over XML--cov=src/mavedbto exclude test files and migrations from the reportReferences