GitHub Actions - CodeAnt AI

CodeAnt AI Coverage Upload Action

Upload test coverage reports to CodeAnt AI for comprehensive analysis, visualization, and tracking of your code coverage metrics. You can find this action on the GitHub Marketplace.

Features

📊 Upload coverage reports in XML format (Cobertura XML, JaCoCo XML)
🔍 Automatic coverage analysis and insights
📈 Track coverage trends over time
🎯 Integration with pull requests
🚀 Easy setup with minimal configuration

Usage

Basic Example

name: Test Coverage

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  coverage:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Run tests with coverage
        run: |
          # Your test command that generates coverage report
          pytest --cov --cov-report=xml

      - name: Upload coverage to CodeAnt AI
        uses: CodeAnt-AI/codeant-coverage-action@v0.0.5
        with:
          access_token: ${{ secrets.ACCESS_TOKEN_GITHUB }}
          coverage_file: coverage.xml

Advanced Example

- name: Upload coverage to CodeAnt AI
  uses: CodeAnt-AI/codeant-coverage-action@v0.0.5
  with:
    access_token: ${{ secrets.ACCESS_TOKEN_GITHUB }}
    coverage_file: coverage.xml
    api_base: https://api.codeant.ai
    platform: github
    base_url: https://github.com
    module: backend
    module_path: services/backend

Inputs

Input	Description	Required	Default
`access_token`	GitHub Access Token for authentication	Yes	-
`coverage_file`	Path to the coverage XML file (e.g., coverage.xml)	Yes	`coverage.xml`
`api_base`	CodeAnt AI API base URL	No	`https://api.codeant.ai`
`platform`	Git platform (github, gitlab, bitbucket)	No	`github`
`base_url`	Base URL of the git platform	No	`https://github.com`
`module`	Module name for monorepo setups	No	-
`module_path`	Module path for resolving files in monorepo	No	-

Multiple Coverage Files (Monorepo)

When a single commit produces several coverage reports — for example one per service in a monorepo — give each upload its own module and module_path. CodeAnt AI keeps the reports separate so each module is tracked, displayed, and gated independently. Without module, every upload writes to the same key and later steps overwrite earlier ones.

module is the logical name shown in the UI (e.g. backend, frontend).
module_path is the directory used to resolve source files referenced in the coverage XML (e.g. services/backend). If your XML’s filename attributes are relative to the module root, set module_path to that root.

Recommended: a single job with `strategy.matrix`

Instead of duplicating the upload step per module, define it once and fan it out with strategy.matrix. Each matrix entry becomes its own parallel job; adding a new module is one new entry instead of an entire job stanza.

name: Test Coverage

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  coverage:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        include:
          - module: backend
            module_path: services/backend
            coverage_file: services/backend/coverage.xml
          - module: frontend
            module_path: services/frontend
            coverage_file: services/frontend/coverage/cobertura-coverage.xml
          - module: api
            module_path: services/api
            coverage_file: services/api/coverage.xml

    steps:
      - uses: actions/checkout@v4

      - name: Run tests and generate coverage
        working-directory: ${{ matrix.module_path }}
        run: |
          # Your test command that emits ${{ matrix.coverage_file }}
          pytest --cov --cov-report=xml

      - name: Upload coverage to CodeAnt AI
        uses: CodeAnt-AI/codeant-coverage-action@v0.0.5
        with:
          access_token: ${{ secrets.ACCESS_TOKEN_GITHUB }}
          coverage_file: ${{ matrix.coverage_file }}
          module: ${{ matrix.module }}
          module_path: ${{ matrix.module_path }}

GitHub spawns one job per matrix entry — coverage (backend), coverage (frontend), etc. — and each runs the upload independently with its own module, module_path, and coverage_file.

Alternative: one step per module

If you prefer the explicit form (e.g. each module has a different test command that can’t be parameterized cleanly), call the action once per module:

- name: Upload backend coverage
  uses: CodeAnt-AI/codeant-coverage-action@v0.0.5
  with:
    access_token: ${{ secrets.ACCESS_TOKEN_GITHUB }}
    coverage_file: services/backend/coverage.xml
    module: backend
    module_path: services/backend

- name: Upload frontend coverage
  uses: CodeAnt-AI/codeant-coverage-action@v0.0.5
  with:
    access_token: ${{ secrets.ACCESS_TOKEN_GITHUB }}
    coverage_file: services/frontend/coverage/cobertura-coverage.xml
    module: frontend
    module_path: services/frontend

Supported Coverage Formats

Important: Only XML format is supported for coverage reports.

Cobertura XML (.xml)
JaCoCo XML

Setup

1. Get Your GitHub Access Token

Log in to your GitHub account
Go to Settings > Developer settings > Personal access tokens > Tokens (classic)
Click Generate new token (classic)
Select the repo scope
Generate and copy the token

2. Generate Coverage Report

First, ensure your test suite generates a coverage report. Here are examples for common languages: Python (pytest)

pytest --cov --cov-report=xml

JavaScript/TypeScript (Jest)

jest --coverage --coverageReporters=cobertura

Java (Maven)

mvn test jacoco:report

go test -coverprofile=coverage.out ./...
gocov convert coverage.out | gocov-xml > coverage.xml

3. Add Secrets

Add your GitHub Access Token to your repository secrets (after generating it via Settings → Developer settings → Personal access tokens):

Go to your repository Settings
Navigate to Secrets and variables → Actions
Click “New repository secret”
Name: ACCESS_TOKEN_GITHUB
Value: Your GitHub Access Token

4. Configure Workflow

Add the action to your GitHub Actions workflow as shown in the usage examples above.

Token Permissions

The access token requires the following permissions:

Metadata: Read-only access
Commit statuses: Read and write access

These permissions allow the token to access repository metadata and update commit status checks for coverage reporting.

Coverage config file

You have to create a .coveragerc file in the project’s root folder to include all the source files in the test coverage calculation. Example:

# include every Python file under the repo root
source = .

# exclude tests, virtualenvs, build artifacts, etc.
omit =
    */tests/*
    */.venv/*
    */build/*
    */dist/*

When you assign source to ”.” , It checks for every python file in the root folder and its sub directories. You can omit some directories by placing them in the omit section of the file.

How it works

With the above configuration:

coverage run -m pytest tests/ will count every .py under the workspace as “valid” lines except for those in the omitted directories.
Lines actually executed by your tests are marked “covered.”
coverage xml -o coverage.xml produces a Cobertura-style report reflecting true coverage over the entire codebase.
Using this coverage xml, we calculate the coverage percentage and the status check will be done on every new push to the branch.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For issues, questions, or contributions, please visit the GitHub repository.

Documentation Index

​CodeAnt AI Coverage Upload Action

​Features

​Usage

​Basic Example

​Advanced Example

​Inputs

​Multiple Coverage Files (Monorepo)

​Recommended: a single job with strategy.matrix

​Alternative: one step per module

​Supported Coverage Formats

​Setup

​1. Get Your GitHub Access Token

​2. Generate Coverage Report

​3. Add Secrets

​4. Configure Workflow

​Token Permissions

​Coverage config file

​How it works

​License

​Support