API¶
Pyrig plugin that integrates Codecov coverage reporting into a project.
rig ¶
Codecov overrides of pyrig's scaffolding and maintenance layer.
Mirrors pyrig's own rig namespace so its plugin-discovery mechanism
automatically picks up this package's overrides and additions.
configs ¶
Declarative definitions of the configuration files managed by this plugin.
This package is this plugin's discovery scope for pyrig's config-file management: every file this plugin manages or overrides is defined here.
version_control ¶
Codecov customizations for generated version-control configuration.
remote ¶
Codecov customizations for generated GitHub remote-repository configuration.
workflows ¶
Codecov-specific overrides for GitHub Actions workflow configuration.
Generate a health-check workflow that uploads matrix coverage to Codecov.
Bases: HealthCheckWorkflowConfigFile
Store matrix reports and upload them to Codecov in a separate job.
Return a name identifying a matrix OS and Python version.
coverage_reports_dir() -> Path
Return the directory containing downloaded coverage artifacts.
Build the OIDC-enabled job that uploads matrix reports to Codecov.
Source code in src/pyrig_codecov/rig/configs/version_control/remote/workflows/health_check.py
Place the coverage upload immediately after the matrix health checks.
Source code in src/pyrig_codecov/rig/configs/version_control/remote/workflows/health_check.py
Return the checkout read and Codecov OIDC token permissions.
Source code in src/pyrig_codecov/rig/configs/version_control/remote/workflows/health_check.py
Download this run's reports into separate artifact directories.
Separate directories prevent identically named reports from overwriting.
Source code in src/pyrig_codecov/rig/configs/version_control/remote/workflows/health_check.py
Upload reports from the artifact directory using OIDC.
Fail the job if the upload fails.
Source code in src/pyrig_codecov/rig/configs/version_control/remote/workflows/health_check.py
Store this matrix job's coverage XML as an artifact.
Fail if the coverage report file is missing.
Source code in src/pyrig_codecov/rig/configs/version_control/remote/workflows/health_check.py
Add coverage artifact storage after the matrix test steps.
Source code in src/pyrig_codecov/rig/configs/version_control/remote/workflows/health_check.py
Check out the repository, then download and upload reports.
Without checkout the Codecov uploader cannot map report paths to tracked repository files.
Source code in src/pyrig_codecov/rig/configs/version_control/remote/workflows/health_check.py
resources ¶
Static resource files bundled with the project.
tools ¶
Tool definitions and overrides contributed by this plugin.
This package is this plugin's discovery scope for pyrig's tool management: every tool this plugin defines or overrides is declared here.
testing ¶
Codecov-specific overrides of pyrig's test-and-coverage tool wrappers.
project ¶
Codecov-specific coverage reporting and badge configuration.
ProjectTester ¶
Bases: ProjectTester
Coverage tool configured for Codecov as the reporting backend.
Points the coverage badge at Codecov instead of a static shields.io badge, raises the required coverage threshold to 100%, and exposes the report file and format needed to publish results to Codecov from CI.
Return the base pytest flags, extended with a report-format flag.
Returns:
| Type | Description |
|---|---|
Args
|
The base pytest flags plus a |
Args
|
flag set to |
Source code in src/pyrig_codecov/rig/tools/testing/project.py
image_url() -> str
Return the URL of the Codecov coverage badge image for the default branch.
Source code in src/pyrig_codecov/rig/tools/testing/project.py
link_url() -> str
Return the URL of the Codecov project dashboard.
Source code in src/pyrig_codecov/rig/tools/testing/project.py
report_file() -> Path
Return the coverage report file path.
Returns:
| Type | Description |
|---|---|
Path
|
|
Return the base ignore paths plus the coverage report file.