LCOV Pull Request Report

Action for reporting LCOV code coverage on pull requests

Sample Report

LCOV Report - Todo App ✅

All Files

• Lines: 1440/1842 (78.2%) ✅ (Minimum coverage is 70%)
• Functions: N/A
• Branches: N/A

Changed Files

• Lines: 50/50 (100.0%) ✅ (Minimum coverage is 90%)
• Functions: N/A
• Branches: N/A

File	Lines	Functions	Branches
app_user.dart	7/7 (100.0%)	N/A	N/A
cart_service.dart	43/43 (100.0%)	N/A	N/A

Usage

# Required for generating html artifact, can be skipped if not generating html artifact
- uses: hrishikesh-kadam/setup-lcov@v1 

- uses: kefasjw/lcov-pull-request-report@v1
  with:
    # Lcov file location. For example, coverage/lcov.info
    lcov-file: coverage/lcov.info

    # Github token required for getting list of changed files and posting comments
    github-token: ${{ secrets.GITHUB_TOKEN }}
    
    # Working directory
    # Default: empty (repository root)
    working-directory:

    # Report comment title
    # Default: empty
    comment-title:

    # All files minimum coverage in percentage. For example, 0, 50, 100
    # Default: 0
    all-files-minimum-coverage:

    # Changed files minimum coverage in percentage. For example, 0, 50, 100
    # Default: 0
    changed-files-minimum-coverage:

    # Artifact name of the generated html. Requires LCOV to be installed
    # Default: empty (skip uploading artifact)
    artifact-name:

Permissions

Write permission must be granted to allow writing pull request comments. There are multiple methods available, but you only need to implement one:

1. Enable "Read and write permissions" in Repository Settings > Code and automation > Actions > General > Workflow permissions.
2. Add permissions: write-all to the job. Refer to GitHub documentation for more details.
3. If you require more granular control over the permissions, you can specify only the necessary permissions. Please note that this will default all other permissions to none:

   permissions: 
     contents: read
     pull-requests: write

License

The scripts and documentation in this project are released under the MIT License