/coveralls-python-action

GitHub Action for Python Coveralls.io

Primary LanguagePythonMIT LicenseMIT

coveralls-python-action

push Coverage Status

GitHub Action for Python Coveralls.io

Screenshot

coveralls-python-action

Usage

First make sure your coverage.py is configured with relative_files = True.

Then assuming you have a make test that runs coverage testing. The following workflow will upload it to coveralls.io.

name: push
on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: actions/setup-python@v1

    - name: Unit tests
      run: make test

    - name: Coveralls
      uses: AndreMiras/coveralls-python-action@develop
      with:
        parallel: true

  coveralls_finish:
    needs: test
    runs-on: ubuntu-latest
    steps:
    - name: Coveralls Finished
      uses: AndreMiras/coveralls-python-action@develop
      with:
        parallel-finished: true

Configuration

- uses: AndreMiras/coveralls-python-action@develop
  with:
    # The `GITHUB_TOKEN` or `COVERALLS_REPO_TOKEN`.
    # Default: ${{ github.token }}
    github-token: ''
    # Set to `true` if you are using parallel jobs, then use `parallel-finished: true` for the last action.
    # Default: false
    parallel: ''
    # Set to `true` for the last action when using `parallel: true`.
    # Default: false
    parallel-finished: ''
    # Set to true to increase logger verbosity.
    # Default: false
    debug: ''