workflows

rules.yml

The workflow runs the tests and the documentation examples of the packages managed by pip. It also can evaluate the coverage and update codecov.

If dependabot is present in the repo and the codecov_token is used, this could generate issues, since dependabot has no access to the repo secrets.

For public repos, the codecov_token is not required, otherwise see here to enable the access.

Usage

uses: qiboteam/workflow/.github/workflows/rules.yml@main
with:
    inputs:
        # The used os.
        # Mandatory input 
        os: 'ubuntu-latest'
        # The python version to be installed.
        # Mandatory input
        python-version: 3.9
        # Name of the repository 
        # calling the reusable workflow. 
        # Mandatory input 
        environment: "qibo"
        # pip extra flags to add 
        # to package's installation.
        # Default: ""
        pip-extras: " "
        # If 'doctest' is true the documentation 
        # examples will be tested. 
        # Default: false
        doctests: true 
            
secrets:
    # Token to update codecov.
    # Not mandatory.
    codecov_token: $