GitHub Action Setup

Automatically enhance test coverage as part of your CI pipelines using Qodo Cover's GitHub Action.

1. Run Qodo Cover to extend existing test suites throughout the repository, in order to increase overall test coverage.

2. Trigger Qodo Cover on a code change, to ensure the new code is properly tested with good coverage.

Once Qodo Cover is added to your repository as a Github Action, it can be triggered in various scenarios: when a new PR is opened, on a scheduled basis, manually and more.

Learn more about Qodo Cover's GitHub Action in our GitHub repository:

GitHub - qodo-ai/qodo-ci: Increase your code coverageGitHub

Setup GitHub Action

Example Usage

Use Qodo's example repository to help you set up Qodo Cover GitHub Action:

GitHub - qodo-ai/qodo-ci-exampleGitHub

Add the following to your workflow:

name: Run Qodo-Cover

on:
  pull_request:
    branches:
      - main
    types:
      - opened # Trigger only when a pull request is opened

permissions:
  pull-requests: write # Allows commenting on pull requests
  contents: write # Allows reading and writing files

jobs:
  run-qodo-cover:
    runs-on: ubuntu-22.04
    steps:
      
      ... # Set up your python test environment

      - name: qodo-cover
        uses: qodo-ai/qodo-ci/.github/actions/qodo-cover@v0.1.1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          project_language: python
          project_root: <path/to/your/python/project>
          code_coverage_report_path: <path/to/your/coverage.xml>
          test_command: "pytest --cov=. --cov-report=xml --cov-report=term"
          model: gpt-4o

        env:
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

Inputs

Variable Name	Description	Required?	Default
github_token	GitHub token for authentication	Yes	N/A
project_language	Programming language of the project	No	python
project_root	Root directory of the project	No	.
code_coverage_report_path	Path to the coverage.xml file	No	./coverage.xml
test_command	Command to run tests (must generate coverage.xml)	Yes	N/A
model	LLM model name	No	gpt-4o
max_iterations	Maximum test generation attempts per file	No	3
desired_coverage	Target coverage percentage	No	100

Repository secret

Add OPENAI_API_KEY to your repository secrets.

Note: This requirement is temporary. We will enable users to issue access tokens from their Qodo Portal in a future release.

Workflow permissions

For this action to work you must explicitly allow GitHub Actions to create pull requests. This setting can be found in a repository's settings under Actions > General > Workflow permissions.

Outputs

If the Qodo Cover agent succeeds in improving coverage it will comment on your PR with a link to a patch PR containing the new tests.