Skip to content

Commit

Permalink
update prerequisites
Browse files Browse the repository at this point in the history
  • Loading branch information
qododavid committed Feb 21, 2025
1 parent e73daa5 commit 76e68a0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,26 @@ Both actions help automatically generate and enhance test coverage using AI-powe
* Typescript
* *More coming soon!*

## Workflow Permissions
---

## Prerequisites

### Repository Permissions

For Qodo Cover to work, you must explicitly allow GitHub Actions to create pull requests.
This setting can be found under:
**Settings** > **Actions** > **General** > **Workflow permissions**.

Ensure **"Allow GitHub Actions to create and approve pull requests"** is enabled.

![Repo Permission](media/gh-permission.png)

### Repository secret

Add `OPENAI_API_KEY` to your [repository secrets](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository).

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

---

## Usage
Expand Down Expand Up @@ -184,25 +196,23 @@ When this action runs on a pull request, it analyzes the changes in that PR, gen

---

### Repository secret

Add `OPENAI_API_KEY` to your [repository secrets](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository).

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

## 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.

![Qodo Cover PR Example](media/qodo-cover-pr.png)

---

## Limitations

* Must run on ubuntu-22.04 x64
* Will only add test cases to existing test files
* You must provide a test command that produces coverage reports in Cobertura or Jacoco XML format (e.g. with pytest and pytest-cov)
* You must provide your own OpenAI API key

---

## Roadmap

* [ ] Support QodoAI auth so user doesn't have to bring their own LLM API key
Expand Down
Binary file added media/gh-permission.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 76e68a0

Please sign in to comment.