Skip to content

Commit b7bc28c

Browse files
Merge branch 'master' into create-ai-risk-documentation
2 parents f7aa3cf + 083f87b commit b7bc28c

28 files changed

+16
-45
lines changed

docs/codacy-ai/codacy-ai.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@ Codacy AI utilizes only enterprise-grade instances of OpenAI and Google Gemini s
1010

1111
### AI-enhanced comments
1212

13+
!!! note
14+
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).
15+
1316
_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._
1417

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

17-
More details about [AI-enhanced comments here](../repositories-configure/integrations/github-integration.md#ai-enhanced-comments).
18-
1920
**How to turn it on**
2021

2122
1. Go to your organization or repository settings in Codacy.
@@ -77,7 +78,7 @@ More details about [AI Reviewer here](../repositories-configure/integrations/git
7778

7879
1. Go to your organization or repository settings in Codacy.
7980
2. Navigate to the "Integrations" or "AI features" section (depending on your Codacy plan and UI version).
80-
3. Find "AI Reviewer", under "Status checks", and toggle the feature to "On" for the repository or organization scope you want to enable.
81+
3. Find "AI Reviewer", under "Pull request summary", and toggle the feature to "On" for the repository or organization scope you want to enable.
8182
4. Save your changes. Once enabled, Codacy will start adding a Summary to your pull requests based on the AI-enriched reviews.
8283
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.
8384

docs/faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Coverage information is currently sent to GitHub by a new version of the Codacy Coverage engine, which depends on updated app permissions.
88

9-
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).
9+
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).
1010

1111
## Outdated permissions or invalid SSH key {: id="outdated-permissions"}
1212

docs/release-notes/cloud/cloud-2023-01.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ These release notes are for the Codacy Cloud updates during January 2023.
2525

2626
- 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)
2727

28-
- 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)
28+
- 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)
2929

3030
![Coverage summary on GitHub](../images/cov-2.png)
3131

docs/release-notes/cloud/cloud-2023-11-23-new-coverage-engine-status-checks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ If you are using the old status check to block merging pull requests on GitHub,
115115

116116
## GitHub coverage summaries from the new Coverage engine {: id="coverage-summaries"}
117117

118-
!!! 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"
118+
!!! info "This section applies to the repositories for which you set Codacy to post coverage summaries to your GitHub pull requests"
119119

120120
{%
121121
include-markdown "../../assets/includes/coverage-github-accept-permissions.md"

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

Lines changed: 9 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Enable the GitHub integration to have status checks, annotations, issue and coverage summaries, and suggested fixes from Codacy directly on pull requests.
2+
description: Enable the GitHub integration to have status checks, annotations, issue summaries, pull request summaries, and suggested fixes from Codacy directly on pull requests.
33
---
44

55
# GitHub integration
@@ -30,7 +30,7 @@ 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-
### Pull request review {: id="pull-request-review"}
33+
### Pull request summary {: id="pull-request-summary"}
3434

3535
{%
3636
include-markdown "../../assets/includes/paid.md"
@@ -41,23 +41,24 @@ Adds a report to your pull requests showing whether your pull requests and cover
4141
!!! note
4242
This feature is only supported on GitHub.
4343

44-
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.
44+
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.
4545

46-
#### Enable AI reviewer {: id="ai-reviewer"}
46+
![Pull request summary](images/pull-request-summary.png)
4747

48-
!!! note
49-
If you enable the AI Reviewer, consider disabling AI-enhanced comments to avoid receiving duplicate comments on Codacy issues.
48+
#### Enable AI Reviewer {: id="ai-reviewer"}
49+
50+
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.
5051

51-
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.
52+
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.
5253

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

5556
Configure when the AI Reviewer runs using the **Run reviewer** setting:
5657

5758
| Mode | Behaviour |
5859
|------|-----------|
59-
| 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. |
6060
| Automatically (first review only) | Codacy runs the reviewer once automatically when the pull request is opened, then requires manual triggering for subsequent updates. |
61+
| 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. |
6162

6263
!!! tip
6364
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
7778

7879
![Issue summary on GitHub](images/github-integration-pr-summary.png)
7980

80-
### Coverage summaries
81-
82-
!!! warning "Coverage summary is moving to Pull request review"
83-
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).
84-
85-
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.
86-
87-
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.
88-
89-
!!! important
90-
**To get coverage summaries** you must also [add coverage to your repository](../../coverage-reporter/index.md).
91-
92-
![Coverage summary on GitHub](images/github-integration-coverage-summary.png)
93-
94-
!!! note
95-
This feature is only supported on GitHub and GitLab Cloud.
96-
9781
### Suggested fixes {: id="suggest-fixes"}
9882

9983
{%
@@ -104,22 +88,8 @@ When there are new coverage results, Codacy updates the last coverage summary co
10488

10589
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).
10690

107-
!!! tip
108-
Enable also **AI-enhanced comments** to get ready-to-commit AI-generated fixes.
109-
11091
![Comment suggesting a fix on GitHub](images/github-integration-suggest-fixes.png)
11192

112-
### AI-enhanced comments
113-
114-
!!! warning "AI-enhanced comments (Beta) is being deprecated on March 16, 2026"
115-
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).
116-
117-
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.
118-
119-
{% include-markdown "../../assets/includes/ai-info.md" %}
120-
121-
![AI-enhanced comment on GitHub](images/github-integration-ai-comment.png)
122-
12393
## See also
12494

12595
- [Integrating Codacy with your Git workflow](../../getting-started/integrating-codacy-with-your-git-workflow.md)
-21 Bytes
Loading
-21 Bytes
Loading
-21 Bytes
Loading
-21 Bytes
Loading
-21 Bytes
Loading

0 commit comments

Comments
 (0)