diff --git a/docs/codacy-ai/codacy-ai.md b/docs/codacy-ai/codacy-ai.md index 22f53250a9..d008ab4dcc 100644 --- a/docs/codacy-ai/codacy-ai.md +++ b/docs/codacy-ai/codacy-ai.md @@ -10,12 +10,13 @@ Codacy AI utilizes only enterprise-grade instances of OpenAI and Google Gemini s ### AI-enhanced comments +!!! note + This feature is available on GitLab and Bitbucket. It is no longer available on GitHub, where it has been replaced by the [AI Reviewer](#ai-reviewer). + _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. -More details about [AI-enhanced comments here](../repositories-configure/integrations/github-integration.md#ai-enhanced-comments). - **How to turn it on** 1. Go to your organization or repository settings in Codacy. @@ -77,7 +78,7 @@ More details about [AI Reviewer here](../repositories-configure/integrations/git 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. +3. Find "AI Reviewer", under "Pull request summary", 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 based on the AI-enriched reviews. 5. To request a PR review, click **Run Reviewer** in the Summary or call our [public API](https://api.codacy.com/api/api-docs#triggerpullrequestaireview). Your review will be published as soon as it's ready. diff --git a/docs/faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md b/docs/faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md index 7fc842c933..bf3d290ba9 100644 --- a/docs/faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md +++ b/docs/faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md @@ -6,7 +6,7 @@ Coverage information is currently sent to GitHub by a new version of the Codacy Coverage engine, which depends on updated app permissions. -If you stopped receiving coverage summaries on your pull requests, please [review and accept the updated Codacy app permissions on GitHub](https://docs.github.com/en/enterprise-cloud@latest/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#reviewing-permissions). For more information on the rollout of the new Coverage engine, [see the relevant release note](../../release-notes/cloud/cloud-2023-11-23-new-coverage-engine-status-checks.md). +If you stopped seeing coverage information in the pull request summaries, please [review and accept the updated Codacy app permissions on GitHub](https://docs.github.com/en/enterprise-cloud@latest/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#reviewing-permissions). For more information on the rollout of the new Coverage engine, [see the relevant release note](../../release-notes/cloud/cloud-2023-11-23-new-coverage-engine-status-checks.md). ## Outdated permissions or invalid SSH key {: id="outdated-permissions"} diff --git a/docs/release-notes/cloud/cloud-2023-01.md b/docs/release-notes/cloud/cloud-2023-01.md index 150e5e987f..c186776fe1 100644 --- a/docs/release-notes/cloud/cloud-2023-01.md +++ b/docs/release-notes/cloud/cloud-2023-01.md @@ -25,7 +25,7 @@ These release notes are for the Codacy Cloud updates during January 2023. - The documentation now includes an end-to-end example illustrating the usage of an [API endpoint to identify commits without coverage data](../../codacy-api/examples/identifying-commits-without-coverage-data.md) to troubleshoot issues with the calculation of coverage metrics. (DOCS-503) -- Codacy now supports [reporting a summary of the coverage metrics](../../repositories-configure/integrations/github-integration.md#coverage-summaries) directly on your pull requests. For now, this feature is only supported on GitHub Cloud. (COV-2, COV-3) +- Codacy now supports reporting a summary of the coverage metrics directly on your pull requests. For now, this feature is only supported on GitHub Cloud. (COV-2, COV-3) ![Coverage summary on GitHub](../images/cov-2.png) diff --git a/docs/release-notes/cloud/cloud-2023-11-23-new-coverage-engine-status-checks.md b/docs/release-notes/cloud/cloud-2023-11-23-new-coverage-engine-status-checks.md index c7b6230cdb..50aeb640c1 100644 --- a/docs/release-notes/cloud/cloud-2023-11-23-new-coverage-engine-status-checks.md +++ b/docs/release-notes/cloud/cloud-2023-11-23-new-coverage-engine-status-checks.md @@ -115,7 +115,7 @@ If you are using the old status check to block merging pull requests on GitHub, ## GitHub coverage summaries from the new Coverage engine {: id="coverage-summaries"} -!!! info "This section applies to the repositories for which you set Codacy to post [coverage summaries](../../repositories-configure/integrations/github-integration.md#coverage-summaries) to your GitHub pull requests" +!!! info "This section applies to the repositories for which you set Codacy to post coverage summaries to your GitHub pull requests" {% include-markdown "../../assets/includes/coverage-github-accept-permissions.md" diff --git a/docs/repositories-configure/integrations/github-integration.md b/docs/repositories-configure/integrations/github-integration.md index 834447062e..2155ac78e1 100644 --- a/docs/repositories-configure/integrations/github-integration.md +++ b/docs/repositories-configure/integrations/github-integration.md @@ -1,5 +1,5 @@ --- -description: Enable the GitHub integration to have status checks, annotations, issue and coverage summaries, and suggested fixes from Codacy directly on pull requests. +description: Enable the GitHub integration to have status checks, annotations, issue summaries, pull request summaries, and suggested fixes from Codacy directly on pull requests. --- # GitHub integration @@ -30,7 +30,7 @@ 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) -### Pull request review {: id="pull-request-review"} +### Pull request summary {: id="pull-request-summary"} {% include-markdown "../../assets/includes/paid.md" @@ -41,14 +41,15 @@ Adds a report to your pull requests showing whether your pull requests and cover !!! note This feature is only supported on GitHub. -When enabled, Codacy posts a **Codacy's Analysis Summary** comment on your pull requests each time a new analysis completes, giving you a full overview of code quality, security, complexity, and duplication metric changes, without requiring you to open the Codacy app. +When enabled, Codacy posts a comment on your pull requests each time a new analysis completes. The comment shows the quality gate result and breaks down issues, metrics (complexity and duplication), and coverage (diff coverage and coverage variation), giving you a full picture of the impact of your changes without leaving GitHub. -#### Enable AI reviewer {: id="ai-reviewer"} +![Pull request summary](images/pull-request-summary.png) -!!! note - If you enable the AI Reviewer, consider disabling AI-enhanced comments to avoid receiving duplicate comments on Codacy issues. +#### Enable AI Reviewer {: id="ai-reviewer"} + +When enabled, the AI Reviewer posts a standalone code review on the pull request and adds a trigger section to the pull request summary comment, allowing you to run the reviewer on demand. When disabled, the trigger section does not appear in the pull request summary comment. -The AI Reviewer extends Pull request reviews with an AI-powered code analysis. It combines the reliability of deterministic, rule-based static code analysis with the enhanced context and prioritization capabilities of AI. It draws in the necessary context from PR metadata, Jira ticket if [integration exists](../../organizations/integrations/jira-integration.md), source code, and Codacy data to ensure the business intent matches the technical outcome, and can catch logic gaps that conventional scanners (and human reviewers) often miss. +The AI Reviewer combines the reliability of deterministic, rule-based static code analysis with the enhanced context and prioritization capabilities of AI. It draws in the necessary context from PR metadata, Jira ticket if [integration exists](../../organizations/integrations/jira-integration.md), source code, and Codacy data 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. @@ -56,8 +57,8 @@ Configure when the AI Reviewer runs using the **Run reviewer** setting: | Mode | Behaviour | |------|-----------| -| Manually | Click **Run Reviewer** in the pull request comment or call our [public API](https://api.codacy.com/api/api-docs#triggerpullrequestaireview) to trigger a review on demand. | | Automatically (first review only) | Codacy runs the reviewer once automatically when the pull request is opened, then requires manual triggering for subsequent updates. | +| Manually | Click **Run Reviewer** in the pull request summary comment or call our [public API](https://api.codacy.com/api/api-docs#triggerpullrequestaireview) to trigger a review on demand. | !!! tip Improve the AI Reviewer results by providing custom instructions. [Learn how to do it here](../../codacy-ai/codacy-ai.md#custom-instructions). @@ -77,23 +78,6 @@ Shows an overall view of the changes in the pull request, including new issues a ![Issue summary on GitHub](images/github-integration-pr-summary.png) -### Coverage summaries - -!!! warning "Coverage summary is moving to Pull request review" - In the coming weeks, Codacy will include coverage data in the Pull request review comment and remove the Coverage summary setting. [Learn more](../../release-notes/cloud/cloud-2026-03-github-integration-settings-changes.md#coverage-summary). - -Adds a pull request comment showing an overall view of the coverage metrics for the pull request, including details about the data that Codacy used to calculate the coverage variation and diff coverage metrics. - -When there are new coverage results, Codacy updates the last coverage summary comment if it's included in the last 5 comments of the pull request. Otherwise, Codacy creates a new comment. - -!!! important - **To get coverage summaries** you must also [add coverage to your repository](../../coverage-reporter/index.md). - -![Coverage summary on GitHub](images/github-integration-coverage-summary.png) - -!!! note - This feature is only supported on GitHub and GitLab Cloud. - ### Suggested fixes {: id="suggest-fixes"} {% @@ -104,22 +88,8 @@ When there are new coverage results, Codacy updates the last coverage summary co Adds comments on the lines of the pull request where Codacy finds new issues with suggestions on how to fix the issues. Codacy doesn't apply any changes automatically. To apply the changes, [manually review and accept the suggestions](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request#applying-suggested-changes). -!!! tip - Enable also **AI-enhanced comments** to get ready-to-commit AI-generated fixes. - ![Comment suggesting a fix on GitHub](images/github-integration-suggest-fixes.png) -### AI-enhanced comments - -!!! warning "AI-enhanced comments (Beta) is being deprecated on March 16, 2026" - This feature is being replaced by the AI Reviewer, which provides a more accurate and comprehensive experience. [Learn more](../../release-notes/cloud/cloud-2026-03-github-integration-settings-changes.md#ai-enhanced-comments). - -Adds AI-enhanced comments, providing insights and ready-to-commit AI-generated fixes for identified issues in cases where tool-suggested fixes are not supported. To enable this option, you must enable **Suggested fixes** first. - -{% include-markdown "../../assets/includes/ai-info.md" %} - -![AI-enhanced comment on GitHub](images/github-integration-ai-comment.png) - ## See also - [Integrating Codacy with your Git workflow](../../getting-started/integrating-codacy-with-your-git-workflow.md) diff --git a/docs/repositories-configure/integrations/images/bitbucket-integration-ai-comment.png b/docs/repositories-configure/integrations/images/bitbucket-integration-ai-comment.png index ecfaf84f54..1315c02b50 100644 Binary files a/docs/repositories-configure/integrations/images/bitbucket-integration-ai-comment.png and b/docs/repositories-configure/integrations/images/bitbucket-integration-ai-comment.png differ diff --git a/docs/repositories-configure/integrations/images/bitbucket-integration-pr-comment.png b/docs/repositories-configure/integrations/images/bitbucket-integration-pr-comment.png index 4389a7cb5b..f93820123a 100644 Binary files a/docs/repositories-configure/integrations/images/bitbucket-integration-pr-comment.png and b/docs/repositories-configure/integrations/images/bitbucket-integration-pr-comment.png differ diff --git a/docs/repositories-configure/integrations/images/bitbucket-integration-pr-status.png b/docs/repositories-configure/integrations/images/bitbucket-integration-pr-status.png index a559d29c55..0bccd9c984 100644 Binary files a/docs/repositories-configure/integrations/images/bitbucket-integration-pr-status.png and b/docs/repositories-configure/integrations/images/bitbucket-integration-pr-status.png differ diff --git a/docs/repositories-configure/integrations/images/bitbucket-integration-pr-summary.png b/docs/repositories-configure/integrations/images/bitbucket-integration-pr-summary.png index 1620c4c633..a5ce86e495 100644 Binary files a/docs/repositories-configure/integrations/images/bitbucket-integration-pr-summary.png and b/docs/repositories-configure/integrations/images/bitbucket-integration-pr-summary.png differ diff --git a/docs/repositories-configure/integrations/images/bitbucket-integration-refresh.png b/docs/repositories-configure/integrations/images/bitbucket-integration-refresh.png index 6600dd36dc..275b9c18b7 100644 Binary files a/docs/repositories-configure/integrations/images/bitbucket-integration-refresh.png and b/docs/repositories-configure/integrations/images/bitbucket-integration-refresh.png differ diff --git a/docs/repositories-configure/integrations/images/bitbucket-integration.png b/docs/repositories-configure/integrations/images/bitbucket-integration.png index 5ba629b7a8..60518f541e 100644 Binary files a/docs/repositories-configure/integrations/images/bitbucket-integration.png and b/docs/repositories-configure/integrations/images/bitbucket-integration.png differ diff --git a/docs/repositories-configure/integrations/images/github-integration-ai-comment.png b/docs/repositories-configure/integrations/images/github-integration-ai-comment.png index 97ab3d4057..479d69e849 100644 Binary files a/docs/repositories-configure/integrations/images/github-integration-ai-comment.png and b/docs/repositories-configure/integrations/images/github-integration-ai-comment.png differ diff --git a/docs/repositories-configure/integrations/images/github-integration-ai-reviewer.png b/docs/repositories-configure/integrations/images/github-integration-ai-reviewer.png index 543b4b9021..7ba71fd714 100644 Binary files a/docs/repositories-configure/integrations/images/github-integration-ai-reviewer.png and b/docs/repositories-configure/integrations/images/github-integration-ai-reviewer.png differ diff --git a/docs/repositories-configure/integrations/images/github-integration-coverage-summary.png b/docs/repositories-configure/integrations/images/github-integration-coverage-summary.png index 7a8d8a47a4..e3296bebd1 100644 Binary files a/docs/repositories-configure/integrations/images/github-integration-coverage-summary.png and b/docs/repositories-configure/integrations/images/github-integration-coverage-summary.png differ diff --git a/docs/repositories-configure/integrations/images/github-integration-pr-annotation.png b/docs/repositories-configure/integrations/images/github-integration-pr-annotation.png index def2eff610..d242ef2bfd 100644 Binary files a/docs/repositories-configure/integrations/images/github-integration-pr-annotation.png and b/docs/repositories-configure/integrations/images/github-integration-pr-annotation.png differ diff --git a/docs/repositories-configure/integrations/images/github-integration-pr-status.png b/docs/repositories-configure/integrations/images/github-integration-pr-status.png index 24d6cce495..7dea536ca8 100644 Binary files a/docs/repositories-configure/integrations/images/github-integration-pr-status.png and b/docs/repositories-configure/integrations/images/github-integration-pr-status.png differ diff --git a/docs/repositories-configure/integrations/images/github-integration-pr-summary.png b/docs/repositories-configure/integrations/images/github-integration-pr-summary.png index a5543e77b8..d5801ca63a 100644 Binary files a/docs/repositories-configure/integrations/images/github-integration-pr-summary.png and b/docs/repositories-configure/integrations/images/github-integration-pr-summary.png differ diff --git a/docs/repositories-configure/integrations/images/github-integration-suggest-fixes.png b/docs/repositories-configure/integrations/images/github-integration-suggest-fixes.png index 7f0dcb1fe6..600a8566c1 100644 Binary files a/docs/repositories-configure/integrations/images/github-integration-suggest-fixes.png and b/docs/repositories-configure/integrations/images/github-integration-suggest-fixes.png differ diff --git a/docs/repositories-configure/integrations/images/github-integration.png b/docs/repositories-configure/integrations/images/github-integration.png index ca31243779..bd5db1890c 100644 Binary files a/docs/repositories-configure/integrations/images/github-integration.png and b/docs/repositories-configure/integrations/images/github-integration.png differ diff --git a/docs/repositories-configure/integrations/images/gitlab-integration-ai-comment.png b/docs/repositories-configure/integrations/images/gitlab-integration-ai-comment.png index bc89c38040..506e5ea58f 100644 Binary files a/docs/repositories-configure/integrations/images/gitlab-integration-ai-comment.png and b/docs/repositories-configure/integrations/images/gitlab-integration-ai-comment.png differ diff --git a/docs/repositories-configure/integrations/images/gitlab-integration-coverage-summary.png b/docs/repositories-configure/integrations/images/gitlab-integration-coverage-summary.png index ecc557e799..9ee385c791 100644 Binary files a/docs/repositories-configure/integrations/images/gitlab-integration-coverage-summary.png and b/docs/repositories-configure/integrations/images/gitlab-integration-coverage-summary.png differ diff --git a/docs/repositories-configure/integrations/images/gitlab-integration-pr-comment.png b/docs/repositories-configure/integrations/images/gitlab-integration-pr-comment.png index 229959a741..4ba6767904 100644 Binary files a/docs/repositories-configure/integrations/images/gitlab-integration-pr-comment.png and b/docs/repositories-configure/integrations/images/gitlab-integration-pr-comment.png differ diff --git a/docs/repositories-configure/integrations/images/gitlab-integration-pr-status.png b/docs/repositories-configure/integrations/images/gitlab-integration-pr-status.png index 49f85ec741..c421196b3b 100644 Binary files a/docs/repositories-configure/integrations/images/gitlab-integration-pr-status.png and b/docs/repositories-configure/integrations/images/gitlab-integration-pr-status.png differ diff --git a/docs/repositories-configure/integrations/images/gitlab-integration-pr-summary.png b/docs/repositories-configure/integrations/images/gitlab-integration-pr-summary.png index ab65c3256f..651f5ab953 100644 Binary files a/docs/repositories-configure/integrations/images/gitlab-integration-pr-summary.png and b/docs/repositories-configure/integrations/images/gitlab-integration-pr-summary.png differ diff --git a/docs/repositories-configure/integrations/images/gitlab-integration-refresh.png b/docs/repositories-configure/integrations/images/gitlab-integration-refresh.png index 5a4acc34bd..eaa73ec5e1 100644 Binary files a/docs/repositories-configure/integrations/images/gitlab-integration-refresh.png and b/docs/repositories-configure/integrations/images/gitlab-integration-refresh.png differ diff --git a/docs/repositories-configure/integrations/images/gitlab-integration.png b/docs/repositories-configure/integrations/images/gitlab-integration.png index a4432d99d1..91a14a5b9c 100644 Binary files a/docs/repositories-configure/integrations/images/gitlab-integration.png and b/docs/repositories-configure/integrations/images/gitlab-integration.png differ diff --git a/docs/repositories-configure/integrations/images/post-commit-hook-create.png b/docs/repositories-configure/integrations/images/post-commit-hook-create.png index 63dbe6990e..f3251a1b12 100644 Binary files a/docs/repositories-configure/integrations/images/post-commit-hook-create.png and b/docs/repositories-configure/integrations/images/post-commit-hook-create.png differ diff --git a/docs/repositories-configure/integrations/images/pull-request-summary.png b/docs/repositories-configure/integrations/images/pull-request-summary.png new file mode 100644 index 0000000000..9c72ad4a9f Binary files /dev/null and b/docs/repositories-configure/integrations/images/pull-request-summary.png differ