coverage-reporter/

claudiacodacy · claudiacodacy · commit 46bae36d1786 · 2025-12-22T11:21:52.000Z
diff --git a/docusaurus/docs/coverage-reporter/_order.ts b/docusaurus/docs/coverage-reporter/_order.ts
diff --git a/docusaurus/docs/coverage-reporter/alternative-ways-of-running-coverage-reporter.mdx b/docusaurus/docs/coverage-reporter/alternative-ways-of-running-coverage-reporter.mdx
@@ -10,7 +10,7 @@ The following sections list the alternative ways of running or installing Codacy
 **If you're using Codacy Self-hosted** make sure that you use a Codacy Coverage Reporter version compatible with your Codacy instance.
 :::
 
-## Bash script (recommended) {#bash-script}
+## Bash script (recommended) \{#bash-script\}
 The recommended way to run the Codacy Coverage Reporter is by using the [self-contained bash script `get.sh`](https://github.com/codacy/codacy-coverage-reporter/blob/master/get.sh) that automatically downloads and runs the most recent version of the Codacy Coverage Reporter:
 
 -   On Ubuntu, run:
diff --git a/docusaurus/docs/coverage-reporter/index.mdx b/docusaurus/docs/coverage-reporter/index.mdx
@@ -24,7 +24,7 @@ Complete these main steps to set up coverage for your repository:
 
 The next sections include detailed instructions on how to complete each step of the setup process.
 
-## 1. Generating coverage reports
+## 1. Generating coverage reports \{#generating-coverage\}
 Before setting up Codacy to display code coverage metrics for your repository you must have tests and use tools to generate coverage reports for the source code files in your repository.
 
 Consider the following when generating coverage reports for your repository:
@@ -129,15 +129,15 @@ If you're generating a report format that Codacy doesn't support yet, [contribut
 -   [<span class="skip-vale">danielpalme/ReportGenerator</span>](https://github.com/danielpalme/ReportGenerator): convert between different report formats
 
 :::caution
-Make sure that you [specify the language](uploading-coverage-in-advanced-scenarios.md#unsupported-languages) when uploading coverage for an unsupported language.
+Make sure that you [specify the language](./uploading-coverage-in-advanced-scenarios.md#unsupported-languages) when uploading coverage for an unsupported language.
 :::
 
 As a last resort, you can also send the coverage data directly by calling one of the following Codacy API endpoints:
 
 -   [<span class="skip-vale">saveCoverage</span>](https://api.codacy.com/swagger#savecoverage)
 -   [saveCoverageWithAccountToken](https://api.codacy.com/swagger#savecoveragewithaccounttoken)
 
-## 2. Uploading coverage data to Codacy
+## 2. Uploading coverage data to Codacy \{#uploading-coverage\}
 After having coverage reports set up for your repository, you must use the Codacy Coverage Reporter to upload them to Codacy. The recommended way to do this is by using a CI/CD platform that automatically runs tests, generates coverage, and then uses the Codacy Coverage Reporter to upload the coverage report information to Codacy.
 
 :::caution
@@ -149,20 +149,20 @@ Please note that Codacy needs to receive coverage data for:
 :::
 
 :::note[Alternative ways of running the Codacy Coverage Reporter]
-Codacy makes available [alternative ways to run the Codacy Coverage Reporter](alternative-ways-of-running-coverage-reporter.md), such as by installing the binary manually or by using Docker, a GitHub Action, or a CircleCI Orb.
+Codacy makes available [alternative ways to run the Codacy Coverage Reporter](./alternative-ways-of-running-coverage-reporter), such as by installing the binary manually or by using Docker, a GitHub Action, or a CircleCI Orb.
 
-However, the instructions on this page assume that you'll run the recommended [self-contained bash script `get.sh`](alternative-ways-of-running-coverage-reporter.md#bash-script) to automatically download and run the most recent version of the Codacy Coverage Reporter.
+However, the instructions on this page assume that you'll run the recommended [self-contained bash script `get.sh`](./alternative-ways-of-running-coverage-reporter#bash-script) to automatically download and run the most recent version of the Codacy Coverage Reporter.
 
 :::
 
 1.  Set up an API token to allow Codacy Coverage Reporter to authenticate on Codacy:
-    -   **If you're setting up coverage for one repository**, [obtain a repository API token](../codacy-api/api-tokens.md#repository-api-tokens) and set the following environment variable to specify your repository API token:
+    -   **If you're setting up coverage for one repository**, [obtain a repository API token](../codacy-api/api-tokens#repository-api-tokens) and set the following environment variable to specify your repository API token:
 
         ```bash
         export CODACY_PROJECT_TOKEN=<your repository API token>
         ```
 
-    -   **If you're setting up and automating coverage for multiple repositories**, [obtain an account API Token](../codacy-api/api-tokens.md#account-api-tokens) and set the following environment variables:
+    -   **If you're setting up and automating coverage for multiple repositories**, [obtain an account API Token](../codacy-api/api-tokens#account-api-tokens) and set the following environment variables:
 
         -   **CODACY_API_TOKEN:** Your account API token.
 
@@ -206,7 +206,7 @@ However, the instructions on this page assume that you'll run the recommended [s
     Be sure to also check the [instructions for more advanced scenarios](uploading-coverage-in-advanced-scenarios.md) while uploading the coverage data to Codacy, such as when running parallel tests, using monorepos, or testing source code in multiple or unsupported languages.
     :::
 
-## 3. Validating that the coverage setup is complete
+## 3. Validating that the coverage setup is complete \{#validating-coverage\}
 Codacy displays the code coverage in each branch, as well as the evolution of code coverage between commits and the code coverage variation introduced by pull requests.
 
 Because of this, to ensure that all code coverage metrics are available on Codacy, you must have successfully uploaded coverage data and analyzed:
@@ -237,7 +237,7 @@ Follow these instructions to validate that your coverage setup is working correc
 
     If there are commits with a status different from **Processed**, please follow the troubleshooting instructions for the corresponding error status and click the button **Test integration** to display any new coverage reports uploaded to Codacy.
 
-    ### Commit not found
+    ### Commit not found \{#status-commit-not-found\}
     Codacy doesn't have information about the commit associated with the coverage data.
 
     <table>
@@ -272,7 +272,7 @@ Follow these instructions to validate that your coverage setup is working correc
 	    </tbody>
 	    </table>
 
-    ### Branch not enabled
+    ### Branch not enabled \{#status-branch-not-enabled\}
     The commit associated with the coverage data doesn't belong to any branch that Codacy is analyzing.
 
     <table>
@@ -307,7 +307,7 @@ Follow these instructions to validate that your coverage setup is working correc
     </tbody>
     </table>
 
-    ### Commit not analyzed
+    ### Commit not analyzed \{#status-commit-not-analyzed\}
     Due to technical limitations, Codacy only reports coverage for a commit after successfully completing the static code analysis of that commit.
 
     <table>
@@ -335,7 +335,7 @@ Follow these instructions to validate that your coverage setup is working correc
             Codacy didn't analyze the commit on a private repository because the committer doesn't belong to the Codacy organization.
         </td>
         <td>
-            Make sure that you <a href="../organizations/managing-people/#adding-people">add all committers to your Codacy organization</a>.
+            Make sure that you <a href="../organizations/managing-people#adding-people">add all committers to your Codacy organization</a>.
         </td>
     </tr>
     <tr>
@@ -365,7 +365,7 @@ Follow these instructions to validate that your coverage setup is working correc
     </tbody>
     </table>
 
-    ### Final report not sent
+    ### Final report not sent \{#status-final-report-not-sent\}
     Codacy is waiting to receive more coverage data before reporting the coverage for a commit.
 
     <table>
@@ -391,7 +391,7 @@ Follow these instructions to validate that your coverage setup is working correc
 	    </tbody>
 	    </table>
 
-    ### Pending
+    ### Pending \{#status-pending\}
     Codacy is waiting to receive valid coverage data for the files in your repository.
 
     <table>
@@ -448,7 +448,7 @@ Follow these instructions to validate that your coverage setup is working correc
 
     ![Commits that must have received coverage data](images/coverage-pr-commits.png)
 
-    Click **View logs** on a pull request detail page to see the SHA-1 hashes of the commits that are missing coverage data. If you have many open pull requests, you can also use a script to [identify if any pull requests are missing coverage data](../codacy-api/examples/identifying-commits-without-coverage-data.md).
+    Click **View logs** on a pull request detail page to see the SHA-1 hashes of the commits that are missing coverage data. If you have many open pull requests, you can also use a script to [identify if any pull requests are missing coverage data](../codacy-api/examples/identifying-commits-without-coverage-data).
 
     ![Logs showing the pull request commits that are missing coverage data](images/coverage-codacy-ui-logs.png)
 
@@ -466,5 +466,5 @@ If you need help setting up coverage on your repository please contact us at [su
 
 ## See also
 
--   [Identifying commits without coverage data](../codacy-api/examples/identifying-commits-without-coverage-data.md)
--   [Why does Codacy show unexpected coverage changes?](../faq/code-analysis/why-does-codacy-show-unexpected-coverage-changes.md)
+-   [Identifying commits without coverage data](../codacy-api/examples/identifying-commits-without-coverage-data)
+-   [Why does Codacy show unexpected coverage changes?](../faq/code-analysis/why-does-codacy-show-unexpected-coverage-changes)
diff --git a/docusaurus/docs/coverage-reporter/troubleshooting-coverage-cli-issues.mdx b/docusaurus/docs/coverage-reporter/troubleshooting-coverage-cli-issues.mdx
@@ -19,15 +19,15 @@ The sections below provide instructions or workarounds to overcome common issues
 
 ## Can't guess any report due to no matching
 
-Codacy Coverage Reporter automatically searches for coverage reports matching the [file name conventions for supported formats](index.md#generating-coverage).
+Codacy Coverage Reporter automatically searches for coverage reports matching the [file name conventions for supported formats](./index.md#generating-coverage).
 
 However, if Codacy Coverage Reporter doesn't find your coverage report, you can explicitly define the report file name with the flag `-r`. For example:
 
 ```bash
 bash <(curl -Ls https://coverage.codacy.com/get.sh) report -r <coverage report file name>
 ```
 
-## Can't validate checksum {#checksum}
+## Can't validate checksum \{#checksum\}
 Starting on version [13.0.0](https://github.com/codacy/codacy-coverage-reporter/releases/tag/13.0.0) the `get.sh` script automatically validates the checksum of the downloaded Codacy Coverage Reporter binary. This requires having either the `sha512sum` or `shasum` command on the operating system where you're running the script.
 
 If you're getting this error while uploading your coverage data to Codacy, install the correct version of `sha512sum` or `shasum` for the operating system that you're using.
@@ -38,7 +38,7 @@ You can also skip validating the checksum of the binary by defining the followin
 export CODACY_REPORTER_SKIP_CHECKSUM=true
 ```
 
-## Commit SHA-1 hash detection {#commit-detection}
+## Commit SHA-1 hash detection \{#commit-detection\}
 The Codacy Coverage Reporter automatically detects the SHA-1 hash of the current commit to associate with the coverage data when you're using one of the following CI/CD platforms:
 
 -   <span class="skip-vale">Appveyor</span>
@@ -99,7 +99,7 @@ If you get a `com.fasterxml.jackson.core.JsonParseException` error while uploadi
 
 There are some ways you can solve this:
 
--   Split your coverage reports into smaller files and [upload them to Codacy one at a time](../uploading-coverage-in-advanced-scenarios/#multiple-reports).
+-   Split your coverage reports into smaller files and [upload them to Codacy one at a time](./uploading-coverage-in-advanced-scenarios#multiple-reports).
 
 -   **If you're using dotCover to generate coverage reports for your C# projects**, you should [exclude <span class="skip-vale">xUnit</span> files](https://www.jetbrains.com/help/dotcover/Running_Coverage_Analysis_from_the_Command_LIne.html#filters_cmd) from the coverage analysis as follows:
 
@@ -128,7 +128,7 @@ Make sure that your coverage report isn't empty and that it includes coverage da
 If you upload multiple coverage reports and at least one contains valid data, the Codacy Coverage Reporter uploads the valid reports and ignores the invalid ones.
 :::
 
-## Report generated an empty result while uploading C# coverage data {#detailedxml}
+## Report generated an empty result while uploading C# coverage data \{#detailedxml\}
 If you're using <span class="skip-vale">dotCover</span> to generate coverage reports for your C# projects, you must use the <span class="skip-vale">dotCover</span> detailedXML report format as follows:
 
 ```bash
diff --git a/docusaurus/docs/coverage-reporter/uploading-coverage-in-advanced-scenarios.mdx b/docusaurus/docs/coverage-reporter/uploading-coverage-in-advanced-scenarios.mdx
@@ -6,7 +6,7 @@ description: Instructions on how to use the Codacy Coverage Reporter to upload c
 
 The following sections include instructions on how to use the Codacy Coverage Reporter to upload coverage data in more advanced scenarios.
 
-## Uploading multiple coverage reports for the same language {#multiple-reports}
+## Uploading multiple coverage reports for the same language \{#multiple-reports\}
 If your test suite is split into different modules or runs in parallel, you must upload multiple coverage reports for the same language either at once or in sequence.
 
 Alternatively, consider merging multiple coverage reports before uploading them to Codacy. Most coverage tools support merging or aggregating coverage data. For example, use the [merge mojo for JaCoCo](http://www.eclemma.org/jacoco/trunk/doc/merge-mojo.html).
@@ -15,7 +15,7 @@ Alternatively, consider merging multiple coverage reports before uploading them
 If one or more coverage reports mark a line as covered multiple times, Codacy counts it as a single covered line when calculating coverage.
 :::
 
-### Uploading all reports at once {#multiple-reports-once}
+### Uploading all reports at once \{#multiple-reports-once\}
 Upload multiple partial coverage reports with a single command by specifying each report with the flag `-r`. For example:
 
 ```bash
@@ -30,7 +30,7 @@ bash <(curl -Ls https://coverage.codacy.com/get.sh) report \
     -l Java $(find . -name 'jacoco*.xml' | sed 's,^, -r ,' | xargs echo)
 ```
 
-### Uploading reports in sequence {#multiple-reports-sequence}
+### Uploading reports in sequence \{#multiple-reports-sequence\}
 Upload multiple partial coverage reports in sequence:
 
 1.  Upload each report <span class="skip-vale">separately</span> with the flag `--partial`.
@@ -49,7 +49,7 @@ bash <(curl -Ls https://coverage.codacy.com/get.sh) report \
 bash <(curl -Ls https://coverage.codacy.com/get.sh) final
 ```
 
-## Uploading the same coverage report for multiple languages {#multiple-languages}
+## Uploading the same coverage report for multiple languages \{#multiple-languages\}
 If your test suite generates a single coverage report for more than one language, you must upload the same coverage report for each language.
 
 To do this, upload the same report multiple times, specifying each different language with the flag `-l`. For example:
@@ -62,7 +62,7 @@ bash <(curl -Ls https://coverage.codacy.com/get.sh) report \
 bash <(curl -Ls https://coverage.codacy.com/get.sh) final
 ```
 
-## Uploading coverage for Golang {#golang}
+## Uploading coverage for Golang \{#golang\}
 Codacy can't automatically detect Golang coverage report files because they don't have specific file names.
 
 If you're uploading a Golang coverage report, you must also specify the report type:
@@ -73,7 +73,7 @@ bash <(curl -Ls https://coverage.codacy.com/get.sh) report \
     --force-coverage-parser go -r unit.coverage.out
 ```
 
-## Uploading coverage for unsupported languages {#unsupported-languages}
+## Uploading coverage for unsupported languages \{#unsupported-languages\}
 If your language isn't in the [list of supported languages](index.md#generating-coverage), you can still send coverage to Codacy.
 
 To do this, provide the correct language with the flag `-l`, together with `--force-language`. For example:
diff --git a/docusaurus/sidebars.ts b/docusaurus/sidebars.ts
@@ -72,12 +72,7 @@ const sidebars: SidebarsConfig = {
     },
     {
       type: 'category',
-      label: 'Coverage reporter',
-      items: coverageReporterOrder,
-    },
-    {
-      type: 'category',
-      label: 'FAQ',
+      label: 'Troubleshooting & FAQs',
       items: faqOrder,
     },
     'special-thanks',
