diff --git a/README.md b/README.md index 35452a0..cc913aa 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,11 @@ 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: @@ -38,6 +42,14 @@ This setting can be found under: 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 @@ -184,18 +196,14 @@ 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 @@ -203,6 +211,8 @@ If the Qodo Cover agent succeeds in improving coverage it will comment on your P * 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 diff --git a/media/gh-permission.png b/media/gh-permission.png new file mode 100644 index 0000000..4a53103 Binary files /dev/null and b/media/gh-permission.png differ