Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions docs/codacy-ai/codacy-ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

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.

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

Check failure on line 7 in docs/codacy-ai/codacy-ai.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Microsoft.Contractions] Use 'won't' instead of 'will not'. Raw Output: {"message": "[Microsoft.Contractions] Use 'won't' instead of 'will not'.", "location": {"path": "docs/codacy-ai/codacy-ai.md", "range": {"start": {"line": 7, "column": 194}}}, "severity": "ERROR"}

## AI Features

### AI-enhanced comments

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.

This feature is strictly opt-in: it will only run on repositories or projects where a repository admin has enabled it.
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.

Check warning on line 15 in docs/codacy-ai/codacy-ai.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Microsoft.Adverbs] Consider removing 'strictly'. Raw Output: {"message": "[Microsoft.Adverbs] Consider removing 'strictly'.", "location": {"path": "docs/codacy-ai/codacy-ai.md", "range": {"start": {"line": 15, "column": 46}}}, "severity": "WARNING"}

How to turn it on

Expand All @@ -35,6 +35,13 @@

### Smart False Positive Triage

{%
include-markdown "../assets/includes/paid.md"
start="<!--paid-feature-business-start-->"
end="<!--paid-feature-business-end-->"
%}

This feature leverages OpenAI models, and is strictly opt-in: you need to get in touch with us in order to enable it.

Check warning on line 44 in docs/codacy-ai/codacy-ai.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Microsoft.Adverbs] Consider removing 'strictly'. Raw Output: {"message": "[Microsoft.Adverbs] Consider removing 'strictly'.", "location": {"path": "docs/codacy-ai/codacy-ai.md", "range": {"start": {"line": 44, "column": 46}}}, "severity": "WARNING"}

How to turn it on

Expand All @@ -45,3 +52,24 @@
- 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.
- 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.
- Prompts are neither stored nor visible by anyone

### PR Reviewer

!!! note
PR Reviewer is currently only available on GitHub, for all Team and Business plans.

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.

Check warning on line 61 in docs/codacy-ai/codacy-ai.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Microsoft.Adverbs] Consider removing 'strictly'. Raw Output: {"message": "[Microsoft.Adverbs] Consider removing 'strictly'.", "location": {"path": "docs/codacy-ai/codacy-ai.md", "range": {"start": {"line": 61, "column": 53}}}, "severity": "WARNING"}

How to turn it on

1. Go to your organization or repository settings in Codacy.
2. Navigate to the "Integrations" or "AI features" section (depending on your Codacy plan and UI version).
3. Find "AI Reviewer", under "Status checks", and toggle the feature to "On" for the repository or organization scope you want to enable.

Check failure on line 67 in docs/codacy-ai/codacy-ai.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Microsoft.Quotes] Punctuation should be inside the quotes. Raw Output: {"message": "[Microsoft.Quotes] Punctuation should be inside the quotes.", "location": {"path": "docs/codacy-ai/codacy-ai.md", "range": {"start": {"line": 67, "column": 30}}}, "severity": "ERROR"}

Check failure on line 67 in docs/codacy-ai/codacy-ai.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Microsoft.Quotes] Punctuation should be inside the quotes. Raw Output: {"message": "[Microsoft.Quotes] Punctuation should be inside the quotes.", "location": {"path": "docs/codacy-ai/codacy-ai.md", "range": {"start": {"line": 67, "column": 9}}}, "severity": "ERROR"}
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.
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.

Check failure on line 69 in docs/codacy-ai/codacy-ai.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'Codacy' instead of 'codacy'. Raw Output: {"message": "[Vale.Terms] Use 'Codacy' instead of 'codacy'.", "location": {"path": "docs/codacy-ai/codacy-ai.md", "range": {"start": {"line": 69, "column": 32}}}, "severity": "ERROR"}

Notes

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

Check failure on line 73 in docs/codacy-ai/codacy-ai.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Microsoft.Contractions] Use 'doesn't' instead of 'does not'. Raw Output: {"message": "[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.", "location": {"path": "docs/codacy-ai/codacy-ai.md", "range": {"start": {"line": 73, "column": 10}}}, "severity": "ERROR"}
- 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.
- Prompts are neither stored nor visible by anyone
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/repositories-configure/integrations/github-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,17 @@ Adds a report to your pull requests showing whether your pull requests and cover

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

### AI Reviewer

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.

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.

![AI Reviewer on Github](images/github-integration-ai-reviewer.png)

!!! note
This feature is only supported on GitHub.

### Issue annotations

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.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading