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: docusaurus/docs/codacy-guardrails/codacy-guardrails-how-to-configure-rules.mdx
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
---
2
2
title: How to customize the analysis rules for Codacy Guardrails
3
+
sidebar_label: Customizing analysis rules
3
4
---
4
5
5
6
By default, if no API token is provided in the [MCP Server setup](codacy-guardrails-getting-started#3-install-mcp-server), Codacy uses a predefined configuration that includes all recommended rules (or [code patterns](../repositories-configure/configuring-code-patterns) that you can find on many parts of our product) from the supported built-in scanners.
Copy file name to clipboardExpand all lines: docusaurus/docs/getting-started/adding-a-codacy-badge.mdx
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,18 @@
2
2
title: Adding a Codacy badge
3
3
---
4
4
5
-
6
5
Add a Codacy badge to the README of your repository to display the current [code quality grade](../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade) or [code coverage](../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage) of your repository.
7
6
8
-
<!-- vale off -->
7
+
8
+
{/*<!-- vale off -->*/}
9
9
10
-
<!-- vale on -->
10
+
{/*<!-- vale on -->*/}
11
11
12
-
To obtain your Codacy badge, open your repository **Settings**, tab **General**, select the markup language, and copy the generated code to your README file. You can also add a badge for your coverage if you have [set up code coverage](../coverage-reporter/index.md) for your repository.
12
+
To obtain your Codacy badge, open your repository **Settings**, tab **General**, select the markup language, and copy the generated code to your README file. You can also add a badge for your coverage if you have [set up code coverage](../coverage-reporter/index.mdx) for your repository.
13
13
14
14
15
15
16
-
To display the grade or code coverage information of a [different branch](../repositories-configure/managing-branches.mdx) analyzed by Codacy, append `?branch=<branch_name>` to the URL of the badge. For example:
16
+
To display the grade or code coverage information of a [different branch](../repositories-configure/managing-branches) analyzed by Codacy, append `?branch=<branch_name>` to the URL of the badge. For example:
@@ -27,7 +27,7 @@ The Codacy badges for your repository may become unavailable or grayed out if th
27
27
28
28
To fix each badge:
29
29
30
-
-[Reanalyze the branch](../faq/repositories/how-do-i-reanalyze-my-repository.md#reanalyzing-a-branch) associated with the **code quality badge**
30
+
-[Reanalyze the branch](../faq/repositories/how-do-i-reanalyze-my-repository#reanalyzing-a-branch) associated with the **code quality badge**
31
31
- Make sure that you're [generating and uploading code coverage reports](../../coverage-reporter/) for all the commits in the branch associated with the **coverage badge**
32
32
33
-
If these steps don't fix your Codacy badges it can mean that the badges are no longer valid. In this case, [repeat the steps above](#adding-a-codacy-badge) to replace the existing badges with new ones.
33
+
If these steps don't fix your Codacy badges it can mean that the badges are no longer valid. In this case, repeat the steps above to replace the existing badges with new ones.
Copy file name to clipboardExpand all lines: docusaurus/docs/getting-started/codacy-quickstart.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,13 +37,13 @@ To get started, head to [<span class="skip-vale">codacy.com</span>](https://www.
37
37
1.[Choosing an organization](#choosing-organization)
38
38
1.[Adding repositories](#adding-repositories)
39
39
40
-
## 1. Signing-up ||signing-up||
40
+
## 1. Signing-up \{#signing-up\}
41
41
42
42
Sign up with a Git provider such as GitHub, GitLab, or Bitbucket. This links your Codacy user with your Git provider user, making it easier to add repositories to Codacy and invite your teammates.
43
43
44
44
Codacy will request access to your Git provider during the authorization flow. [Check the permissions that Codacy requires and why](which-permissions-does-codacy-need-from-my-account).
45
45
46
-
## 2. Choosing an organization ||choosing-organization||
46
+
## 2. Choosing an organization \{#choosing-organization\}
47
47
48
48
Now, you'll need to add or join the organizations that contain your repositories. The organization with the same name as your Git provider username contains your personal repositories. Read more about [organizations on Codacy](../../organizations/what-are-organizations).
49
49
@@ -55,7 +55,7 @@ If you can't see the organization you're looking for, [follow these troubleshoot
55
55
56
56
Next, add the repositories that you wish to analyze. Codacy begins an initial analysis as soon as you add a repository and sets everything up to ensure your next commits on that repository are analyzed.
61
61
@@ -73,4 +73,4 @@ Click the repository name to navigate to the repository dashboard and see the [c
73
73
74
74
## Next steps
75
75
76
-
The first analysis is based on default tool and pattern configurations. It's now important that you configure your repository to integrate code analysis seamlessly into your existing pipeline. See how to [configure your repository to match the use cases of your team](configuring-your-repository.md).
76
+
The first analysis is based on default tool and pattern configurations. It's now important that you configure your repository to integrate code analysis seamlessly into your existing pipeline. See how to [configure your repository to match the use cases of your team](configuring-your-repository).
Copy file name to clipboardExpand all lines: docusaurus/docs/getting-started/configuring-your-repository.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,15 +19,15 @@ To configure your repository, follow these steps:
19
19
20
20
## 1. Ignoring files \{#ignoring-files\}
21
21
22
-
[Ignore any files and directories](../repositories-configure/ignoring-files.md) that aren't relevant for the Codacy analysis, such as generated code or any third-party libraries included in your repositories.
22
+
[Ignore any files and directories](../repositories-configure/ignoring-files) that aren't relevant for the Codacy analysis, such as generated code or any third-party libraries included in your repositories.
[Configure the tools and code patterns](../repositories-configure/configuring-code-patterns.md) that Codacy uses to analyze your repository. If security is important for your team, review the [Security and risk management dashboard](../organizations/managing-security-and-risk.md) to ensure that your configuration detects potential security issues.
27
+
[Configure the tools and code patterns](../repositories-configure/configuring-code-patterns) that Codacy uses to analyze your repository. If security is important for your team, review the [Security and risk management dashboard](../organizations/managing-security-and-risk) to ensure that your configuration detects potential security issues.
28
28
29
29
:::tip
30
-
To ensure that multiple repositories consistently follow the same global tool and code pattern configurations, [use an organization coding standard](../organizations/using-coding-standards.md).
30
+
To ensure that multiple repositories consistently follow the same global tool and code pattern configurations, [use an organization coding standard](../organizations/using-coding-standards).
31
31
:::
32
32
33
33
@@ -40,8 +40,8 @@ It's important that you set up coverage beforehand because Codacy can only repor
40
40
41
41
42
42
## Next steps \{#next-steps\}
43
-
Once you’re satisfied with your setup, [integrate Codacy with your Git workflow](integrating-codacy-with-your-git-workflow.md) to flag potential issues, block problematic pull requests, and display other useful suggestions directly on your Git provider.
43
+
Once you’re satisfied with your setup, [integrate Codacy with your Git workflow](./integrating-codacy-with-your-git-workflow) to flag potential issues, block problematic pull requests, and display other useful suggestions directly on your Git provider.
44
44
45
45
:::tip
46
-
To showcase the current code quality grade and coverage, [add a Codacy badge to your repository](adding-a-codacy-badge.md).
46
+
To showcase the current code quality grade and coverage, [add a Codacy badge to your repository](./adding-a-codacy-badge).
Copy file name to clipboardExpand all lines: docusaurus/docs/getting-started/integrating-codacy-with-intellij-ides.mdx
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,19 +12,19 @@ The [Codacy IntelliJ plugin](https://github.com/codacy/codacy-intellij-extension
12
12
13
13
The main view of the Codacy IntelliJ plugin provides a summary of the code quality and coverage changes introduced by the pull request of the currently checked-out branch.
In the main view, you can find the following information:
18
18
19
-
- The **Status** of the pull request, either up to standards or not up to standards, based on the [Gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
19
+
- The **Status** of the pull request, either up to standards or not up to standards, based on the [Gates](../repositories-configure/adjusting-quality-gates) set for the repository.
20
20
21
-
- Any **issues** introduced or fixed by the pull request. These are the same issues you find in the [Issues tabs](../repositories/pull-requests.mdx#issues-tabs) in the Codacy app and are also visible in IntelliJ's Problems tab.
21
+
- Any **issues** introduced or fixed by the pull request. These are the same issues you find in the [Issues tabs](../repositories/pull-requests#issues-tabs) in the Codacy app and are also visible in IntelliJ's Problems tab.
22
22
23
23
When this item is expanded, the number next to each file name is the total number of issues that the pull request adds to that file.
24
24
25
25
- The **diff coverage** introduced by the pull request. The percentage next to each file name is the coverage variation for that file.
26
26
27
-
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Duplication tabs](../repositories/pull-requests.mdx#duplication-tabs) in the Codacy app.
27
+
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Duplication tabs](../repositories/pull-requests#duplication-tabs) in the Codacy app.
28
28
29
29
- Variations in **code complexity** introduced by the pull request.
30
30
@@ -33,10 +33,10 @@ In the main view, you can find the following information:
33
33
:::note[The Codacy IntelliJ plugin is compatible with IntelliJ IDEA (Ultimate, Community), Android Studio, and Aqua.]
34
34
:::
35
35
36
-
1. Make sure that the repository you’re working on is analyzed by Codacy and that you have a [repository read](../organizations/roles-and-permissions-for-organizations.md) role or higher.
36
+
1. Make sure that the repository you’re working on is analyzed by Codacy and that you have a [repository read](../organizations/roles-and-permissions-for-organizations) role or higher.
37
37
38
38
:::tip
39
-
If this is your first time using Codacy, see [how to add and analyze your first repository](./codacy-quickstart.md#adding-your-first-repository).
39
+
If this is your first time using Codacy, see [how to add and analyze your first repository](./codacy-quickstart#adding-your-first-repository).
40
40
:::
41
41
42
42
1. Install the plugin from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/23924-codacy) or through the [plugin settings panel](https://www.jetbrains.com/help/idea/managing-plugins.html) in your IntelliJ IDE.
@@ -48,12 +48,12 @@ To see Codacy quality and coverage data for an open pull request, follow these s
48
48
1. Open the repository directory in your IntelliJ IDE.
49
49
50
50
:::note
51
-
If the repository isn't on Codacy yet, [add it to Codacy](../organizations/managing-repositories.md#adding-a-repository) first.
51
+
If the repository isn't on Codacy yet, [add it to Codacy](../organizations/managing-repositories#adding-a-repository) first.
52
52
:::
53
53
54
54
1. Open the main view by clicking the **Codacy logo** in the left tool window bar.
55
55
56
-
56
+
57
57
58
58
1. If you’re not signed in, click the **Sign in** button to authorize IntelliJ on Codacy.
59
59
@@ -77,20 +77,20 @@ To review issues:
77
77
78
78
1. Open the **Problems tool window** (use `Ctrl+6` on Windows/Linux or `Cmd+6` on macOS) and select the **File** tab.
79
79
80
-
80
+
81
81
82
82
1. Click the name of the issue you want to review.
83
83
84
84
1. Hover over a highlighted issue in the code editor to view available actions and suggested quick fixes, if available.
85
85
86
-
For a list of tools that support suggested fixes, see [Supported languages and tools](./supported-languages-and-tools.md#supported-languages-and-tools).
86
+
For a list of tools that support suggested fixes, see [Supported languages and tools](./supported-languages-and-tools).
87
87
88
88
1. Once you've addressed the problems in your code, push your changes to the Git provider so that Codacy analyzes the updated code.
89
89
90
90
When the analysis is complete, the Codacy plugin automatically refreshes the pull request analysis result. You can also refresh the pull request data manually by clicking the Refresh Pull Request button in the main view.
91
91
92
92
## Running Codacy Guardrails
93
-
As of version [0.0.8](https://plugins.jetbrains.com/plugin/23924-codacy/versions/stable/840439), the IntelliJ plugin now supports Codacy Guardrails. To see how to get it quickly setup refer to our quickstart guide [here](../codacy-guardrails/codacy-guardrails-getting-started.md#how-to-install-quick-guide-jetbrains).
93
+
As of version [0.0.8](https://plugins.jetbrains.com/plugin/23924-codacy/versions/stable/840439), the IntelliJ plugin now supports Codacy Guardrails. To see how to get it quickly setup refer to our quickstart guide [here](../codacy-guardrails/codacy-guardrails-getting-started#how-to-install-quick-guide-jetbrains).
0 commit comments