Flutter Coverage

Framework Configuration

Key Requirements

Coverage report must be in LCOV format
Report must be saved as coverage/lcov.info
Report must be uploaded as a GitHub Actions artifact named coverage-report

Flutter's built-in test framework can generate LCOV coverage reports.

pubspec.yaml

dev_dependencies:
  flutter_test:
    sdk: flutter

Setting Up GitHub Actions

Create a workflow file in .github/workflows/ directory. The filename can be anything you prefer (e.g. flutter-coverage.yml). Add the following content to your workflow file:

flutter-coverage.yml

name: Flutter Coverage

# Run on target branch (probably default branch like main) to track coverage history
on:
  push:
    branches:
      - main
    # Optional: Only run when relevant files change (customize as needed)
    paths:
      - '**/*.dart'
      - pubspec.yaml
      - pubspec.lock
  pull_request:
    branches:
      - main
    paths:
      - '**/*.dart'
      - pubspec.yaml
      - pubspec.lock
      - '!.github/workflows/**'
  workflow_dispatch:

# Auto-cancel outdated runs on the same branch
concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
  cancel-in-progress: true

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Setup Flutter
        uses: subosito/flutter-action@v2
        with:
          channel: "stable"

      - name: Install dependencies
        run: flutter pub get

      # PR: tests only, Push: tests with coverage
      - name: Run tests
        if: github.event_name == 'pull_request'
        run: flutter test

      - name: Run tests with coverage
        if: github.event_name == 'push'
        run: flutter test --coverage

      - name: Upload coverage report
        if: github.event_name == 'push'
        uses: actions/upload-artifact@v6
        with:
          name: coverage-report
          path: coverage/lcov.info

Key Configuration Points

Run tests with --coverage flag
Upload the report as an artifact - name must be either coverage-report or end with lcov.info
Ensure the artifact contains coverage/lcov.info file

Why `!.github/workflows/**` on PRs Only?

On pull requests, we exclude workflow file changes to keep the setup PR minimal. When you're adding or editing a workflow file, pre-existing test failures in your codebase are irrelevant and shouldn't block the PR. On push(after merge to main), we don't exclude them so that the initial coverage report gets generated on your target branch.

Viewing Coverage Reports

After your workflow runs successfully, GitAuto automatically processes the coverage reports and displays them in the Coverage Dashboard. GitAuto only saves coverage data when the workflow runs on your target branch (configurable in your repository's Rules page, defaults to your repository's default branch, e.g., main or master). This typically happens when:

You merge a pull request to your target branch
You push directly to your target branch
You manually trigger the workflow

About LCOV:LCOV (Linux Code Coverage) is a standard format for code coverage data. It's pronounced "el-cov" and is widely supported by various tools and services.

Using multiple languages? If your repository has multiple programming languages (the docs use PHP + JavaScript as an example, but any combination works), see our Multi-Language Coverage guide for setting up coverage across all languages.