From 0288fc0e014d7c40a14ab2913a92dee4db24bc05 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia?= Date: Fri, 5 Dec 2025 10:40:19 +0000 Subject: [PATCH 1/5] adding links + descriptions --- docs/codacy-ai/codacy-ai.md | 34 ++++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/docs/codacy-ai/codacy-ai.md b/docs/codacy-ai/codacy-ai.md index 288a47a5c1..d93e0a898c 100644 --- a/docs/codacy-ai/codacy-ai.md +++ b/docs/codacy-ai/codacy-ai.md @@ -10,11 +10,13 @@ Codacy AI utilizes only enterprise-grade instances of OpenAI and Google Gemini s ### AI-enhanced comments +_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._ + 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 leverages OpenAI models, and is strictly opt-in: it will only run on repositories or projects where a repository admin has enabled it. +More details about [AI-enhanced comments here](../repositories-configure/integrations/github-integration.md#ai-enhanced-comments). -How to turn it on +**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). @@ -22,13 +24,13 @@ How to turn it on 4. Optionally configure which repositories, branches, or severity levels should receive AI comments to reduce noise. 5. Save your changes. Once enabled, Codacy will start adding AI-enhanced comments to new pull requests and code reviews according to the configured scope. -Notes +**Notes** - Administrators can enable or disable the feature at organization or repository level. - Enabling the feature may be subject to plan limitations and governance controls; check your Codacy subscription and admin permissions. - Users can still ignore or dismiss individual AI comments during code review. -- Data usage and privacy +**Data usage and privacy** - To generate an AI-enhanced comment, Codacy only processes the specific issue context: the issue line plus up to ten lines before and ten lines after that line. No additional repository data is sent or used. - 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. @@ -41,26 +43,34 @@ Notes end="" %} -This feature leverages OpenAI models, and is strictly opt-in: you need to get in touch with us in order to enable it. +_This feature leverages OpenAI models, and is strictly opt-in: you need to get in touch with us in order to enable it._ + +Codacy False Positive triage analyzes results on a commit basis to give you visibility into issues that may be false positives (based on their context). During triage, each issue is given a confidence score along with an explanation. When the confidence level falls below a defined threshold, the issue is then flagged as an AI false positive and surfaced for manual review. You can evaluate potential false positives during a pull request in app or on any Codacy page where issues appear. These issues can be ignored or marked as Not a false positive. + +More details about [False Positives here](../repositories/commits.md#false-positive-issues). -How to turn it on +**How to turn it on** 1. Get in touch with your Customer Success Manager or with -Notes +**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. - 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 +### AI Reviewer !!! note - PR Reviewer is currently only available on GitHub, for all Team and Business plans. + AI 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._ + +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. -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. +More details about [Ai Reviewer here](../repositories-configure/integrations/github-integration.md#ai-reviewer). -How to turn it on +**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). @@ -68,7 +78,7 @@ How to turn it on 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. -Notes +**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. - 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. From 879d533e05179cac5072cc6c86f0ef4015e71b76 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia?= Date: Fri, 5 Dec 2025 11:03:41 +0000 Subject: [PATCH 2/5] =?UTF-8?q?add=20=E2=86=92=20symbols=20to=20links?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/codacy-ai/codacy-ai.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/codacy-ai/codacy-ai.md b/docs/codacy-ai/codacy-ai.md index d93e0a898c..9180105822 100644 --- a/docs/codacy-ai/codacy-ai.md +++ b/docs/codacy-ai/codacy-ai.md @@ -14,7 +14,7 @@ _This feature leverages OpenAI models, and is strictly opt-in: it will only run 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. -More details about [AI-enhanced comments here](../repositories-configure/integrations/github-integration.md#ai-enhanced-comments). +More details about [AI-enhanced comments here →](../repositories-configure/integrations/github-integration.md#ai-enhanced-comments). **How to turn it on** @@ -47,7 +47,7 @@ _This feature leverages OpenAI models, and is strictly opt-in: you need to get i Codacy False Positive triage analyzes results on a commit basis to give you visibility into issues that may be false positives (based on their context). During triage, each issue is given a confidence score along with an explanation. When the confidence level falls below a defined threshold, the issue is then flagged as an AI false positive and surfaced for manual review. You can evaluate potential false positives during a pull request in app or on any Codacy page where issues appear. These issues can be ignored or marked as Not a false positive. -More details about [False Positives here](../repositories/commits.md#false-positive-issues). +More details about [False Positives here →](../repositories/commits.md#false-positive-issues). **How to turn it on** @@ -68,7 +68,7 @@ _This feature leverages Google Gemini models, and is strictly opt-in: it will on 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. -More details about [Ai Reviewer here](../repositories-configure/integrations/github-integration.md#ai-reviewer). +More details about [Ai Reviewer here →](../repositories-configure/integrations/github-integration.md#ai-reviewer). **How to turn it on** From f5b7fd02567b648d9e2b98b9a62b4299bc3b6bdc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia?= Date: Fri, 5 Dec 2025 11:07:57 +0000 Subject: [PATCH 3/5] funcionality notes on AI Reviewer docs --- .../integrations/github-integration.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/repositories-configure/integrations/github-integration.md b/docs/repositories-configure/integrations/github-integration.md index 0b3a35aac4..9d867b8263 100644 --- a/docs/repositories-configure/integrations/github-integration.md +++ b/docs/repositories-configure/integrations/github-integration.md @@ -32,14 +32,20 @@ Adds a report to your pull requests showing whether your pull requests and cover ### AI Reviewer +!!! note + This feature is only supported on GitHub. + + If you choose to enable the AI Reviewer, consider disabling the AI-enhanced comments suggestion, as it may duplicate any comments on Codacy issues you receive. + 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. +This setting can be enabled at a repository or organization level. Once enabled, Codacy will start adding a Summary to your pull requests with of the information used to provide the AI-enriched reviews. 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. + + ![AI Reviewer on Github](images/github-integration-ai-reviewer.png) -!!! note - This feature is only supported on GitHub. ### Issue annotations From 7310c6b7e636913e18af8ab9d058e25004e64b07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia?= Date: Fri, 5 Dec 2025 11:12:24 +0000 Subject: [PATCH 4/5] fix typos + grammar --- docs/codacy-ai/codacy-ai.md | 4 ++-- .../repositories-configure/integrations/github-integration.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/codacy-ai/codacy-ai.md b/docs/codacy-ai/codacy-ai.md index 9180105822..b47eb85f74 100644 --- a/docs/codacy-ai/codacy-ai.md +++ b/docs/codacy-ai/codacy-ai.md @@ -68,14 +68,14 @@ _This feature leverages Google Gemini models, and is strictly opt-in: it will on 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. -More details about [Ai Reviewer here →](../repositories-configure/integrations/github-integration.md#ai-reviewer). +More details about [AI Reviewer here →](../repositories-configure/integrations/github-integration.md#ai-reviewer). **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. -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. +4. Save your changes. Once enabled, Codacy will start adding a Summary to your pull requests with 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. **Notes** diff --git a/docs/repositories-configure/integrations/github-integration.md b/docs/repositories-configure/integrations/github-integration.md index 9d867b8263..7cd9f9ebee 100644 --- a/docs/repositories-configure/integrations/github-integration.md +++ b/docs/repositories-configure/integrations/github-integration.md @@ -35,13 +35,13 @@ Adds a report to your pull requests showing whether your pull requests and cover !!! note This feature is only supported on GitHub. - If you choose to enable the AI Reviewer, consider disabling the AI-enhanced comments suggestion, as it may duplicate any comments on Codacy issues you receive. + If you choose to enable the AI Reviewer, consider disabling the AI-enhanced comments, as it may duplicate any comments on Codacy issues you receive. 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. -This setting can be enabled at a repository or organization level. Once enabled, Codacy will start adding a Summary to your pull requests with of the information used to provide the AI-enriched reviews. 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. +This setting can be enabled at a repository or organization level. Once enabled, Codacy will start adding a Summary to your pull requests with the information used to provide the AI-enriched reviews. 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. ![AI Reviewer on Github](images/github-integration-ai-reviewer.png) From 3ead2a23a58c31539043f1528f7f6ea9216f859f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A1udia?= <83641264+claudiacodacy@users.noreply.github.com> Date: Fri, 5 Dec 2025 11:15:16 +0000 Subject: [PATCH 5/5] Apply suggestions from codacy's code review Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com> --- docs/codacy-ai/codacy-ai.md | 2 +- docs/repositories-configure/integrations/github-integration.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/codacy-ai/codacy-ai.md b/docs/codacy-ai/codacy-ai.md index b47eb85f74..907eaee050 100644 --- a/docs/codacy-ai/codacy-ai.md +++ b/docs/codacy-ai/codacy-ai.md @@ -75,7 +75,7 @@ More details about [AI Reviewer here →](../repositories-configure/integrations 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. -4. Save your changes. Once enabled, Codacy will start adding a Summary to your pull requests with the information used to provide the AI-enriched reviews. +4. Save your changes. Once enabled, Codacy will start adding a Summary to your pull requests based on 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. **Notes** diff --git a/docs/repositories-configure/integrations/github-integration.md b/docs/repositories-configure/integrations/github-integration.md index 7cd9f9ebee..9f673219d3 100644 --- a/docs/repositories-configure/integrations/github-integration.md +++ b/docs/repositories-configure/integrations/github-integration.md @@ -41,7 +41,7 @@ The AI Reviewer combines the reliability of deterministic, rule-based static cod 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. -This setting can be enabled at a repository or organization level. Once enabled, Codacy will start adding a Summary to your pull requests with the information used to provide the AI-enriched reviews. 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. +This setting can be enabled at a repository or organization level. Once enabled, Codacy will start adding a Summary to your pull requests based on the AI-enriched reviews. 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. ![AI Reviewer on Github](images/github-integration-ai-reviewer.png)