NAME

Devel::Cover::Report::Coveralls - coveralls backend for Devel::Cover

USAGE

GitHub Actions

1. Add your repo to coveralls. https://coveralls.io/repos/new

2. Add settings to one of your GitHub workflows. Here assuming you're calling it .github/workflows/ci.yml:

  jobs:
    ubuntu:
      runs-on: ${{ matrix.os }}
      strategy:
        fail-fast: false
        matrix:
          os: [ubuntu-latest]
          perl-version: ['5.10', '5.14', '5.20']
          include:
            - perl-version: '5.30'
              os: ubuntu-latest
              release-test: true
              coverage: true
      container: perl:${{ matrix.perl-version }}
      steps:
        - uses: actions/checkout@v2
        # do other stuff like installing external deps here
        - run: cpanm -n --installdeps .
        - run: perl -V
        - name: Run release tests # before others as may install useful stuff
          if: ${{ matrix.release-test }}
          env:
            RELEASE_TESTING: 1
          run: |
            cpanm -n --installdeps --with-develop .
            prove -lr xt
        - name: Run tests (no coverage)
          if: ${{ !matrix.coverage }}
          run: prove -l t
        - name: Run tests (with coverage)
          if: ${{ matrix.coverage }}
          env:
            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          run: |
            cpanm -n Devel::Cover::Report::Coveralls
            cover -test -report Coveralls

3. Push new change to GitHub

4. Coveralls should update your project page

Travis CI

1. Add your repo to coveralls. https://coveralls.io/repos/new

2. Add setting to .travis.yaml (before_install and script section)

    language: perl
    perl:
      - 5.16.3
      - 5.14.4
    before_install:
      cpanm -n Devel::Cover::Report::Coveralls
    script:
      perl Build.PL && ./Build build && cover -test -report coveralls

3. push new change to github

4. updated coveralls your project page

another CI

1. Get repo_token from your project page in coveralls.

2. Write .coveralls.yml (don't add this to public repo)

    repo_token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

3. Run CI.

DESCRIPTION

https://coveralls.io/ is service to publish your coverage stats online with a lot of nice features. This module provides seamless integration with Devel::Cover in your perl projects.

ENVIRONMENT

Set these environment variables to control the behaviour. Various other variables, set by particular CI environments, will be interpreted silently and correctly.

COVERALLS_REPO_TOKEN

The Coveralls authentication token for this particular repo.

COVERALLS_ENDPOINT

If you have an enterprise installation, set this to change from the default of https://coveralls.io. The rest of the URL (/api, etc) won't change, and will be correct.

COVERALLS_FLAG_NAME

Describe the particular tests being done, e.g. Unit or Functional.

SEE ALSO

https://coveralls.io/ https://coveralls.io/docs https://github.com/coagulant/coveralls-python Devel::Cover

EXAMPLE

https://coveralls.io/r/kan/p5-smart-options

LICENSE

Copyright (C) Kan Fushihara

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Kan Fushihara <kan.fushihara@gmail.com>