diff --git a/docs/codacy-ai/codacy-ai.md b/docs/codacy-ai/codacy-ai.md index 95505a14b8..288a47a5c1 100644 --- a/docs/codacy-ai/codacy-ai.md +++ b/docs/codacy-ai/codacy-ai.md @@ -4,7 +4,7 @@ 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. ## AI Features @@ -12,7 +12,7 @@ Codacy AI utilizes only enterprise-grade instances of OpenAI's services with enh 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. How to turn it on @@ -35,6 +35,13 @@ Notes ### Smart False Positive Triage +{% + include-markdown "../assets/includes/paid.md" + start="" + end="" +%} + +This feature leverages OpenAI models, and is strictly opt-in: you need to get in touch with us in order to enable it. How to turn it on @@ -45,3 +52,24 @@ 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 + +!!! 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. + +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. +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 + +- 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. +- Prompts are neither stored nor visible by anyone diff --git a/docs/organizations/integrations/images/default-git-provider-settings-apply-all.png b/docs/organizations/integrations/images/default-git-provider-settings-apply-all.png index a52c1741f5..ffe618ba2d 100644 Binary files a/docs/organizations/integrations/images/default-git-provider-settings-apply-all.png and b/docs/organizations/integrations/images/default-git-provider-settings-apply-all.png differ diff --git a/docs/organizations/integrations/images/default-git-provider-settings.png b/docs/organizations/integrations/images/default-git-provider-settings.png index 1af719ef38..f7588494fe 100644 Binary files a/docs/organizations/integrations/images/default-git-provider-settings.png and b/docs/organizations/integrations/images/default-git-provider-settings.png differ diff --git a/docs/repositories-configure/integrations/github-integration.md b/docs/repositories-configure/integrations/github-integration.md index 1a76085a96..0b3a35aac4 100644 --- a/docs/repositories-configure/integrations/github-integration.md +++ b/docs/repositories-configure/integrations/github-integration.md @@ -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. diff --git a/docs/repositories-configure/integrations/images/github-integration-ai-reviewer.png b/docs/repositories-configure/integrations/images/github-integration-ai-reviewer.png new file mode 100644 index 0000000000..4d65c1628e Binary files /dev/null and b/docs/repositories-configure/integrations/images/github-integration-ai-reviewer.png differ