TheKevJames / coveralls-python / 7903c745-22a2-4398-a0ff-7d1f48feb00d

95%

master: 94%

Build Type

Pull #752

circleci

Committed by TheKevJames

Commit Message

docs(config): document consistent configuration model

Update the configuration and troubleshooting docs for the single-command CLI,
the new --host/--skip-ssl-verify/--parallel flags, and the renamed
--service-name/--base-dir/--src-dir flags (with deprecation notes). Document
the .coveralls.yml key renames and clean the leaked config_file/base_dir keys
out of the example report fixture.

BREAKING CHANGE: configuration now uses one consistent name per setting across
CLI flags, COVERALLS_* env vars and .coveralls.yml. The 'coveralls_host' and
'config_file' config-file keys are renamed to 'host' and 'rcfile'; the
--service/--basedir/--srcdir flags are renamed to --service-name/--base-dir/
--src-dir (old spellings still work but are deprecated); the 'debug' subcommand
becomes a --debug flag; and the Coveralls(config_file=...) constructor kwarg is
renamed to rcfile. Client settings (base_dir, src_dir, rcfile, host,
skip_ssl_verify, timeouts) are no longer leaked into the submitted payload.

Pull Request Pull Request #752: refactor(config): typed Config model with consistent CLI/env/file/SSL handling

Coverage Stats

146 of 156 branches covered (93.59%)

Branch coverage included in aggregate %.

195 of 198 new or added lines in 3 files covered. (98.48%)

7 existing lines in 2 files now uncovered.

466 of 493 relevant lines covered (94.52%)

5.67 hits per line