Skip to content

Commit 4c2560a

Browse files
committed
faq/code-analysis
1 parent 010a385 commit 4c2560a

9 files changed

+84
-107
lines changed

docusaurus/docs/faq/code-analysis/can-i-bypass-codacy-status-check.md renamed to docusaurus/docs/faq/code-analysis/can-i-bypass-codacy-status-check.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22
title: Can I bypass Codacy status check?
33
---
44

5-
65
:::note
76
**This will only apply to gates enforcing quality checks.** If coverage is blocking a pull request analysis, we recommend contacting your git provider admin or temporarily disabling the coverage gate on the repo and reanalyzing the pull request before enabling them again.
87
:::
98

10-
To protect your code from unwelcome changes, you can [configure your Git workflow to block merging pull requests](../../getting-started/integrating-codacy-with-your-git-workflow.md#blocking-pull-requests) if they don't pass the Codacy status check.
9+
To protect your code from unwelcome changes, you can [configure your Git workflow to block merging pull requests](../../getting-started/integrating-codacy-with-your-git-workflow#blocking-pull-requests) if they don't pass the Codacy status check.
1110

1211
However, on **very specific and exceptional situations** where your pull request merging is blocked due to an unexpected issue not related to the quality of your code, Codacy allows **repository admins** to bypass the Codacy status check for that pull request.
1312

14-
To bypass Codacy status check for a pull request, a repository admin must click **Bypass status checks** on the [pull request status area](../../repositories/pull-requests.mdx#status) of the pull request detail screen.
13+
To bypass Codacy status check for a pull request, a repository admin must click **Bypass status checks** on the [pull request status area](../../repositories/pull-requests#status) of the pull request detail screen.
1514

16-
![Bypass status check for pull request](images/bypass-status-check.png)
15+
![Bypass status check for pull request](./images/bypass-status-check.png)

docusaurus/docs/faq/code-analysis/does-codacy-check-for-dependencies.md renamed to docusaurus/docs/faq/code-analysis/does-codacy-check-for-dependencies.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Does Codacy check for dependencies?
33
---
44

5-
65
Yes, Codacy scans the manifest files of your repositories and displays any vulnerable dependencies as Codacy issues.
76

8-
For a list of supported languages and manifest files scanned by the Codacy dependency vulnerability scanning tools, see [Supported languages and tools](../../getting-started/supported-languages-and-tools.md).
7+
For a list of supported languages and manifest files scanned by the Codacy dependency vulnerability scanning tools, see [Supported languages and tools](../../getting-started/supported-languages-and-tools).

docusaurus/docs/faq/code-analysis/does-codacy-place-limits-on-the-code-analysis.md renamed to docusaurus/docs/faq/code-analysis/does-codacy-place-limits-on-the-code-analysis.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,15 @@
22
title: Does Codacy place limits on the code analysis?
33
---
44

5-
65
Codacy uses limits when performing the analysis of your repositories to ensure good performance levels and avoid degradation of service during peak load.
76

87
The following table describes these limits and includes links to more information and workarounds, if available:
98

10-
<!--NOTE
9+
{/*<!--NOTE
1110
See the comments in this Jira task for more background information on the limits listed on this page:
1211
1312
https://codacy.atlassian.net/browse/CY-3232
14-
-->
13+
-->*/}
1514

1615
<table>
1716
<thead>
@@ -36,7 +35,7 @@ See <a href="../../troubleshooting/why-is-my-file-over-150-kb-missing/">Why is m
3635
<td>10 MB</td>
3736
<td>
3837
Codacy doesn't parse code coverage reports that are over the file size limit.<br/><br/>
39-
See <a href="../../../coverage-reporter/troubleshooting-coverage-cli-issues/#jsonparseexception-while-uploading-coverage-data">JsonParseException while uploading coverage data</a>
38+
See <a href="../../../coverage-reporter/troubleshooting-coverage-cli-issues#jsonparseexception-while-uploading-coverage-data">JsonParseException while uploading coverage data</a>
4039
</td>
4140
</tr>
4241

@@ -79,4 +78,4 @@ If you believe that you may have hit any of these limits and need help to overco
7978

8079
## See also
8180

82-
- [Which metrics does Codacy calculate?](which-metrics-does-codacy-calculate.md)
81+
- [Which metrics does Codacy calculate?](./which-metrics-does-codacy-calculate)

docusaurus/docs/faq/code-analysis/how-long-does-it-take-for-my-repository-to-be-analyzed.md

Lines changed: 0 additions & 30 deletions
This file was deleted.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: How long does it take for my repository to be analyzed?
3+
---
4+
5+
Codacy usually takes under 5 minutes to analyze your repository. It may however take longer, depending on a number of factors:
6+
7+
- **Whether it's the initial analysis of your repository**
8+
The initial analysis examines all files in the repository, while each subsequent commit triggers an analysis only on files changed in that commit.
9+
10+
- **Whether tool configurations have been updated**
11+
Updates to tool configurations trigger a reanalysis of all files in the repository on the next commit and may impact analysis duration.
12+
13+
- **The size of your repository**
14+
To speed up the analysis, [ignore any files and directories](../../repositories-configure/ignoring-files) that aren't relevant to your project, such as generated code or any third-party libraries included in your repositories.
15+
16+
- **The time it takes your Git provider to trigger the analysis**
17+
Codacy relies on post-commit hooks sent by your Git provider to trigger the analysis after each push to the repository, so if your analysis is taking a lot of time to start [check that the Post-Commit Hook integration for your repository is enabled](../../repositories-configure/integrations/post-commit-hooks).
18+
19+
- **The priority of your analysis request and the current load on Codacy's servers**
20+
Open-source projects have lower priority in the Codacy analysis queues.
21+
22+
- **Whether Codacy or your Git provider is currently experiencing issues or outages**
23+
Check the [Codacy status page](https://status.codacy.com/) and the status page of your Git provider ([GitHub](https://www.githubstatus.com/), [GitLab](https://status.gitlab.com/), [Bitbucket](https://bitbucket.status.atlassian.com/)) to see if there is any ongoing incident that could delay the analysis.

docusaurus/docs/faq/code-analysis/how-to-configure-php-codesniffer-coding-standards.md renamed to docusaurus/docs/faq/code-analysis/how-to-configure-php-codesniffer-coding-standards.mdx

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,15 @@ title: How to configure PHP_CodeSniffer coding standards?
33
description: To enforce a specific PHP_CodeSniffer coding standard on Codacy you must create a configuration file on the root of your repository that references one or more coding standards.
44
---
55

6-
7-
By default, Codacy uses the PHP_CodeSniffer configuration on the [Code patterns](../../repositories-configure/configuring-code-patterns.md) page when analyzing your repositories.
6+
By default, Codacy uses the PHP_CodeSniffer configuration on the [Code patterns](../../repositories-configure/configuring-code-patterns) page when analyzing your repositories.
87

98
To enforce a specific PHP_CodeSniffer coding standard you must [create a configuration file](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#using-a-default-configuration-file) on the root of your repository that references one or more of the following coding standards:
109

11-
- Default coding standards packaged together with PHP_CodeSniffer:
12-
13-
[PHP_CodeSniffer coding standards](https://github.com/squizlabs/PHP_CodeSniffer/tree/master/src/Standards)
14-
15-
- Additional coding standards that Codacy packages on the PHP_CodeSniffer tool plugin. Check the repository the additional coding standards to learn how you can reference them in your configuration files:
10+
- Default coding standards packaged together with PHP_CodeSniffer:
11+
[PHP_CodeSniffer coding standards](https://github.com/squizlabs/PHP_CodeSniffer/tree/master/src/Standards)
1612

17-
[codacy-codesniffer composer.json](https://github.com/codacy/codacy-codesniffer/blob/master/composer.json)
13+
- Additional coding standards that Codacy packages on the PHP_CodeSniffer tool plugin. Check the repository the additional coding standards to learn how you can reference them in your configuration files:
14+
[codacy-codesniffer composer.json](https://github.com/codacy/codacy-codesniffer/blob/master/composer.json)
1815

1916
For example, create a text file with the name `phpcs.xml` to use the PSR12 coding standard but excluding the sniffs `Generic.WhiteSpace.DisallowTabIndent` and `PSR12.Operators.OperatorSpacing`:
2017

docusaurus/docs/faq/code-analysis/how-to-skip-an-analysis.md renamed to docusaurus/docs/faq/code-analysis/how-to-skip-an-analysis.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: How to skip an analysis?
33
---
44

5-
65
By default, Codacy automatically analyzes a repository whenever you push changes. However, you can override this behavior by adding one of the "skip" tags - `[ci skip]`, `[skip ci]`, `[codacy skip]` or `[skip codacy]` - anywhere in the subject or body of the commit message. For example:
76

87
```bash

0 commit comments

Comments
 (0)