Skip to content

Commit d5ec2b0

Browse files
Enhance Codacy AI documentation with PR Reviewer (#2531)
* Enhance Codacy AI documentation with PR Reviewer * fix comments on pr * update images * add missing image from settings * add missing image * replace images for org doc --------- Co-authored-by: Cláudia <claudia@codacy.com> Co-authored-by: Cláudia <83641264+claudiacodacy@users.noreply.github.com>
1 parent f2a7548 commit d5ec2b0

File tree

5 files changed

+41
-2
lines changed

5 files changed

+41
-2
lines changed

docs/codacy-ai/codacy-ai.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
Codacy AI is a set of optional features integrated into the Software designed to optimise development workflows and elevate code quality standards through automated issue descriptions, actionable recommendations and false-positive detection, is available for the Customer.
66

7-
Codacy AI utilizes only enterprise-grade instances of OpenAI's services with enhanced security, privacy, and data protection features. Customer Code processed through Codacy AI will not be used by Codacy, OpenAI, or any third-party AI provider for training, improving, or developing artificial intelligence models, machine learning algorithms, or any other automated systems.
7+
Codacy AI utilizes only enterprise-grade instances of OpenAI and Google Gemini services with enhanced security, privacy, and data protection features. Customer Code processed through Codacy AI will not be used by Codacy, OpenAI, or any third-party AI provider for training, improving, or developing artificial intelligence models, machine learning algorithms, or any other automated systems.
88

99
## AI Features
1010

1111
### AI-enhanced comments
1212

1313
AI-enhanced comments are optional, machine-generated suggestions that appear directly in pull requests and review threads. They use Codacy's AI to provide concise issue summaries, remediation suggestions, and links to relevant documentation — helping reviewers and authors quickly understand and fix problems.
1414

15-
This feature is strictly opt-in: it will only run on repositories or projects where a repository admin has enabled it.
15+
This feature leverages OpenAI models, and is strictly opt-in: it will only run on repositories or projects where a repository admin has enabled it.
1616

1717
How to turn it on
1818

@@ -35,6 +35,13 @@ Notes
3535

3636
### Smart False Positive Triage
3737

38+
{%
39+
include-markdown "../assets/includes/paid.md"
40+
start="<!--paid-feature-business-start-->"
41+
end="<!--paid-feature-business-end-->"
42+
%}
43+
44+
This feature leverages OpenAI models, and is strictly opt-in: you need to get in touch with us in order to enable it.
3845

3946
How to turn it on
4047

@@ -45,3 +52,24 @@ Notes
4552
- Codacy does not use your code, repository contents, or comments to train external AI models. No customer code or review text is incorporated into model training.
4653
- To detect a Possible False Positive, Codacy only processes the specific issue context: one request per file with issues. No additional repository data is sent or used.
4754
- Prompts are neither stored nor visible by anyone
55+
56+
### PR Reviewer
57+
58+
!!! note
59+
PR Reviewer is currently only available on GitHub, for all Team and Business plans.
60+
61+
This feature leverages Google Gemini models, and is strictly opt-in: it will only run on repositories or projects where a repository admin has enabled it.
62+
63+
How to turn it on
64+
65+
1. Go to your organization or repository settings in Codacy.
66+
2. Navigate to the "Integrations" or "AI features" section (depending on your Codacy plan and UI version).
67+
3. Find "AI Reviewer", under "Status checks", and toggle the feature to "On" for the repository or organization scope you want to enable.
68+
4. Save your changes. Once enabled, Codacy will start adding a Summary to your pull requests with of the information used to provide the AI-enriched reviews.
69+
5. To request a PR Review from codacy, add a **`codacy-review`** label to your Pull Request. Codacy listens to the event and will publish the review as soon as it's ready.
70+
71+
Notes
72+
73+
- Codacy does not use your code, repository contents, or comments to train external AI models. No customer code or review text is incorporated into model training.
74+
- To enrich the review, the git diff of the Pull Request as well as some related files' contents can be sent as context. No data is stored on our side, or used to train any models.
75+
- Prompts are neither stored nor visible by anyone
-14 KB
Loading
383 KB
Loading

docs/repositories-configure/integrations/github-integration.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,17 @@ Adds a report to your pull requests showing whether your pull requests and cover
3030

3131
![Pull request status check on GitHub](images/github-integration-pr-status.png)
3232

33+
### AI Reviewer
34+
35+
The AI Reviewer combines the reliability of deterministic, rule-based static code analysis with the power of AI. It draws in the necessary context from source code and PR metadata to ensure the business intent matches the technical outcome, and can catch logic gaps that conventional scanners (and human reviewers) often miss.
36+
37+
It provides feedback on missing or weak tests, complex or duplicated code, and keeps security concerns up to date. Beyond that, it adds contextual insights about whether the changes follow the requirements, business rules, and logic used in the project.
38+
39+
![AI Reviewer on Github](images/github-integration-ai-reviewer.png)
40+
41+
!!! note
42+
This feature is only supported on GitHub.
43+
3344
### Issue annotations
3445

3546
Adds annotations on the lines of the pull request where Codacy finds new issues. Codacy maps the severity of the issues reported by the tools to the severity levels of the annotations. To enable this option, you must enable **Status checks** first.
206 KB
Loading

0 commit comments

Comments
 (0)