Description

Validates the codecov.yml configuration file.

This package is simply the curl command described in the codecov documentation converted to python.

This package was inspired by gitlab-lint, package that checks .gitlab-ci.yml configuration file.

Usage

The recommended use is to add in the .pre-commit-config.yaml file

- repo: https://github.com/mashi/codecov-validator
  rev: v1.0.0  # replace by any tag version >= 1.0.0 available
  hooks:
    - id: ccv
      # args: [--filename, .codecov.yml]  # example with arguments

In this way, the codecov.yml file is checked before commit and prevents the user from including invalid files in the version control.

Instructions (Development)

Create a virtual environment and install the required packages with

python3 -m venv .venv
source .venv/bin/activate
pip install wheel
pip install -r requirements.txt
pre-commit install