You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/codacy-ai/codacy-ai.md
+9-3Lines changed: 9 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## What is Codacy AI?
4
4
5
-
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.
5
+
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. These features are available for the Customer.
6
6
7
7
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.
8
8
@@ -66,9 +66,9 @@ More details about [False Positives here](../repositories/commits.md#false-posit
66
66
!!! note
67
67
AI Reviewer is currently only available on GitHub, for all Team and Business plans.
68
68
69
-
_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._
69
+
_This feature leverages Google Gemini models, and is strictly opt-in; it will only run on repositories or organizations where an admin has enabled it._
70
70
71
-
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.
71
+
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.
72
72
73
73
More details about [AI Reviewer here](../repositories-configure/integrations/github-integration.md#ai-reviewer).
74
74
@@ -80,6 +80,12 @@ More details about [AI Reviewer here](../repositories-configure/integrations/git
80
80
4. Save your changes. Once enabled, Codacy will start adding a Summary to your pull requests based on the AI-enriched reviews.
81
81
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.
82
82
83
+
#### Jira context for the AI Reviewer
84
+
85
+
If the Jira integration is enabled, we will automatically attempt to detect the Jira ticket key (ABC-123, case-insensitive) in the Pull request metadata. If found, the ticket title and description will be used to enrich the context of our reviewer.
86
+
87
+
More about the [Jira integration here](../organizations/integrations/jira-integration.md).
88
+
83
89
#### Custom Instructions
84
90
85
91
To improve the results of the AI Reviewer, you can provide custom instructions to the AI Reviewer. These instructions are specific to a repository and help the AI Reviewer understand the structure of the code, the business logic of the project, and your own preferences.
Copy file name to clipboardExpand all lines: docs/organizations/integrations/jira-integration.md
+9Lines changed: 9 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,15 @@ To uninstall the Jira integration, open your organization **Integrations**, page
33
33
!!! important
34
34
Uninstalling the Jira integration as described above deletes all associated open items. You can alternatively uninstall the Jira integration on the Jira website: this doesn't delete anything, but it prevents Codacy from opening new Jira-related items.
35
35
36
+
## AI reviewer context
37
+
38
+
!!! tip
39
+
AI Reviewer is currently only available on GitHub, for all Team and Business plans.
40
+
41
+
If the repository or organization has the AI Reviewer enabled, it will automatically check the Pull Request metadata for a Jira ticket key (ABC-123, case-insensitive). The title and description will be fetched to enrich the review context, and the process will cross-check the required deliverable and acceptance criteria with the existing code changes.
42
+
43
+
More details about [AI Reviewer here](../../repositories-configure/integrations/github-integration.md#ai-reviewer).
44
+
36
45
## Creating Jira tickets from issues, dependencies and files
37
46
38
47
Installing the Jira integration enables the feature of creating Jira tickets from issues, dependencies and files
# Changes to GitHub integration settings – March 2026
7
+
8
+
!!! info "These changes apply only to GitHub"
9
+
10
+
We are making two changes to the GitHub integration settings over the coming weeks. Both are handled automatically - you don't need to take any action.
11
+
12
+
-[**AI-enhanced comments (Beta) being deprecated for GitHub**](#ai-enhanced-comments) — AI-enhanced comments are being replaced by the [AI Reviewer](../../codacy-ai/codacy-ai.md#pr-reviewer) on March 17, 2026.
13
+
-[**Coverage summary moving to Pull request review**](#coverage-summary) — the Coverage summary setting is being removed; coverage data will soon be included in the Pull request review comment.
14
+
15
+
## AI-enhanced comments (Beta) being deprecated on March 17, 2026 {: id="ai-enhanced-comments"}
16
+
17
+
Codacy is deprecating the AI-enhanced comments (Beta) feature in favour of the [AI Reviewer](../../codacy-ai/codacy-ai.md#ai-reviewer), which provides a more accurate, comprehensive, and context-aware experience for identifying and addressing issues.
18
+
19
+
On March 17, 2026, Codacy will migrate all repositories and organizations that have **AI-enhanced comments** enabled to the [AI Reviewer](../../codacy-ai/codacy-ai.md#ai-reviewer) and remove the setting.
20
+
21
+
22
+
!!! note
23
+
Organizations with contractual restrictions on AI providers or content analysis scope will not be automatically migrated to the AI Reviewer. For these organizations, AI-enhanced comments will simply be disabled. The AI Reviewer can be enabled at any time from your [integration settings](../../repositories-configure/integrations/github-integration.md#ai-reviewer). For more information, contact your account manager or <support@codacy.com>.
24
+
25
+
### What to expect
26
+
27
+
- On March 17, 2026, the AI-enhanced comments setting will be removed and any repository or organization where it is enabled will be migrated to the AI Reviewer.
28
+
- Repositories where AI-enhanced comments are not enabled will not have the AI Reviewer enabled automatically.
29
+
- The AI Reviewer defaults to **manual** mode, so your team won't receive unexpected reviews.
30
+
31
+
### What do you need to do?
32
+
33
+
Nothing is required. Codacy will handle the migration automatically.
34
+
35
+
If you prefer, you can enable the AI Reviewer now in your organization and repository integration settings. If you enable it before March 17, 2026, we recommend manually disabling **AI-enhanced comments** at the same time to avoid duplicate comments on Pull Requests.
36
+
37
+
If you have any further questions, contact <support@codacy.com>.
38
+
39
+
### Why this change
40
+
41
+
- The [AI Reviewer](../../codacy-ai/codacy-ai.md#pr-reviewer) uses broader context from source code and PR metadata (and Jira tickets, if enabled), which improves accuracy and reduces noise.
42
+
- You can guide reviews with custom instructions using a `review.md` file in your repository.
43
+
- You can trigger reviews on demand from Pull Requests using the **Run review** button.
44
+
45
+
## Coverage summary moving to Pull request review {: id="coverage-summary"}
46
+
47
+
Codacy is consolidating coverage data into the Pull request review comment so that you get a complete picture of your code quality and security changes in a single place, without the need for a separate comment.
48
+
49
+
In the coming weeks, Codacy will migrate all repositories and organizations that have **Coverage summary** enabled to **Pull request review**. On that date, the Coverage summary setting will be removed.
50
+
51
+
### What to expect
52
+
53
+
- Coverage changes will appear alongside quality and security metrics in the Codacy Analysis Summary PR comment.
54
+
- The Coverage summary setting will be removed.
55
+
- The AI Reviewer is **not** automatically enabled as part of this migration.
56
+
57
+
### What do you need to do?
58
+
59
+
Nothing. Codacy will handle the migration automatically for any repository or organization that had Coverage summary enabled. If you didn't have this setting on, this won't affect you.
@@ -41,17 +41,26 @@ Adds a report to your pull requests showing whether your pull requests and cover
41
41
!!! note
42
42
This feature is only supported on GitHub.
43
43
44
-
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.
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.
45
45
46
-
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.
46
+
#### Enable AI reviewer {: id="ai-reviewer"}
47
+
48
+
!!! note
49
+
If you enable the AI Reviewer, consider disabling AI-enhanced comments to avoid receiving duplicate comments on Codacy issues.
50
+
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.
47
52
48
53
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.
49
54
50
-
!!! tip
51
-
Improve the AI Reviewer results by providing custom instructions. [Learn how to do it here](../../codacy-ai/codacy-ai.md#custom-instructions).
55
+
Configure when the AI Reviewer runs using the **Run reviewer** setting:
52
56
53
-
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, 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.
57
+
| Mode | Behaviour |
58
+
|------|-----------|
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. |
60
+
| Automatically (first review only) | Codacy runs the reviewer once automatically when the pull request is opened, then requires manual triggering for subsequent updates. |
54
61
62
+
!!! tip
63
+
Improve the AI Reviewer results by providing custom instructions. [Learn how to do it here](../../codacy-ai/codacy-ai.md#custom-instructions).
55
64
56
65

57
66
@@ -70,6 +79,9 @@ Shows an overall view of the changes in the pull request, including new issues a
70
79
71
80
### Coverage summaries
72
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
+
73
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.
74
86
75
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.
@@ -99,6 +111,9 @@ Adds comments on the lines of the pull request where Codacy finds new issues wit
99
111
100
112
### AI-enhanced comments
101
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
+
102
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.
0 commit comments