NAME

repomatic lint-coverage - Check the coverage floor keeps up with the coverage total

SYNOPSIS

repomatic lint-coverage [OPTIONS]

DESCRIPTION

Check that the coverage floor keeps up with the coverage total.

Compares the total of a coverage report in JSON with the [tool.coverage] report.fail_under floor of pyproject.toml. A floor more than two points under the total lets a regression of that size through: raise it to about one point under the total.

Exit codes:


    0  The floor keeps up, there is no report or no floor, or --no-fatal.


    1  The floor sits more than two points under the total.

OPTIONS

--report FILE

Coverage report in JSON, as pytest --cov-report=json or coverage json writes it.

--fatal / --no-fatal

Exit non-zero when the floor lags the total. Pass --no-fatal to warn without failing.

--help / -h

Show this message and exit.

ENVIRONMENT

LINT_COVERAGE_REPORT_PATH

Coverage report in JSON, as pytest --cov-report=json or coverage json writes it.

LINT_COVERAGE_FATAL

Exit non-zero when the floor lags the total. Pass --no-fatal to warn without failing.

LINT_COVERAGE__CLICK_DEFAULT_HELP

Show this message and exit.

EXIT STATUS

0

Success.

1

A runtime error, an aborted prompt (Ctrl-D), or a declined confirmation.

2

A usage error: unknown option, invalid value, missing operand, or an unparsable configuration file.

130

Interrupted with Ctrl-C: the process ends by SIGINT, reported as 130.

EXAMPLES

Check against the report in coverage.json

repomatic lint\-coverage

Warn without failing, after a CI test run

repomatic lint\-coverage \-\-report coverage.json \-\-no\-fatal

AUTHORS

Kevin Deldycke