Skip to content

Commit 03f8c4f

Browse files
committed
moved all Id attributes to new format
1 parent 92508cf commit 03f8c4f

28 files changed

Lines changed: 109 additions & 215 deletions

new-docs/src/content/docs/coverage-reporter/alternative-ways-of-running-coverage-reporter.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ The following sections list the alternative ways of running or installing Codacy
1010
**If you're using Codacy Self-hosted {{ extra.codacy_self_hosted_version }}** you must use [Codacy Coverage Reporter {{ extra.codacy_coverage_reporter_version }}](https://github.com/codacy/codacy-coverage-reporter/releases/tag/{{ extra.codacy_coverage_reporter_version }}) to ensure it's compatible with your Codacy instance.
1111
:::
1212

13-
## Bash script (recommended) {: id="bash-script"}
14-
13+
## Bash script (recommended) {#bash-script}
1514
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:
1615

1716
- On Ubuntu, run:

new-docs/src/content/docs/coverage-reporter/index.md

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ Complete these main steps to set up coverage for your repository:
2424

2525
The next sections include detailed instructions on how to complete each step of the setup process.
2626

27-
## 1. Generating coverage reports {: id="generating-coverage"}
28-
27+
## 1. Generating coverage reports {#generating-coverage}
2928
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.
3029

3130
Consider the following when generating coverage reports for your repository:
@@ -142,8 +141,7 @@ As a last resort, you can also send the coverage data directly by calling one of
142141
- [<span class="skip-vale">saveCoverage</span>](https://api.codacy.com/swagger#savecoverage)
143142
- [saveCoverageWithAccountToken](https://api.codacy.com/swagger#savecoveragewithaccounttoken)
144143

145-
## 2. Uploading coverage data to Codacy {: id="uploading-coverage"}
146-
144+
## 2. Uploading coverage data to Codacy {#uploading-coverage}
147145
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.
148146

149147
:::caution
@@ -161,9 +159,7 @@ However, the instructions on this page assume that you'll run the recommended [s
161159

162160
:::
163161

164-
1. Set up an API token to allow Codacy Coverage Reporter to authenticate on Codacy:
165-
{: id="authenticate"}
166-
162+
1. Set up an API token to allow Codacy Coverage Reporter to authenticate on Codacy: {#authenticate}
167163
- **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:
168164
169165
```bash
@@ -214,8 +210,7 @@ However, the instructions on this page assume that you'll run the recommended [s
214210
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.
215211
:::
216212
217-
## 3. Validating that the coverage setup is complete {: id="validating-coverage"}
218-
213+
## 3. Validating that the coverage setup is complete {#validating-coverage}
219214
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.
220215
221216
Because of this, to ensure that all code coverage metrics are available on Codacy, you must have successfully uploaded coverage data and analyzed:
@@ -246,8 +241,7 @@ Follow these instructions to validate that your coverage setup is working correc
246241
247242
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.
248243
249-
### Commit not found {: id="status-commit-not-found" style="color: #EF5454;"}
250-
244+
### Commit not found {#status-commit-not-found}
251245
Codacy doesn't have information about the commit associated with the coverage data.
252246

253247
<table>
@@ -281,8 +275,7 @@ Follow these instructions to validate that your coverage setup is working correc
281275
</tr>
282276
</table>
283277
284-
### Branch not enabled {: id="status-branch-not-enabled" style="color: #EF5454;"}
285-
278+
### Branch not enabled {#status-branch-not-enabled}
286279
The commit associated with the coverage data doesn't belong to any branch that Codacy is analyzing.
287280

288281
<table>
@@ -316,8 +309,7 @@ Follow these instructions to validate that your coverage setup is working correc
316309
</tr>
317310
</table>
318311
319-
### Commit not analyzed {: id="status-commit-not-analyzed" style="color: #EF5454;"}
320-
312+
### Commit not analyzed {#status-commit-not-analyzed}
321313
Due to technical limitations, Codacy only reports coverage for a commit after successfully completing the static code analysis of that commit.
322314
323315
<table>
@@ -374,8 +366,7 @@ Follow these instructions to validate that your coverage setup is working correc
374366
</tr>
375367
</table>
376368
377-
### Final report not sent {: id="status-final-report-not-sent" style="color: #EF5454;"}
378-
369+
### Final report not sent {#status-final-report-not-sent}
379370
Codacy is waiting to receive more coverage data before reporting the coverage for a commit.
380371
381372
<table>
@@ -400,8 +391,7 @@ Follow these instructions to validate that your coverage setup is working correc
400391
</tr>
401392
</table>
402393

403-
### Pending {: id="status-pending" style="color: #2562EA;"}
404-
394+
### Pending {#status-pending}
405395
Codacy is waiting to receive valid coverage data for the files in your repository.
406396

407397
<table>

new-docs/src/content/docs/coverage-reporter/troubleshooting-coverage-cli-issues.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ However, if Codacy Coverage Reporter doesn't find your coverage report, you can
2727
bash <(curl -Ls https://coverage.codacy.com/get.sh) report -r <coverage report file name>
2828
```
2929

30-
## Can't validate checksum {: id="checksum"}
31-
30+
## Can't validate checksum {#checksum}
3231
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.
3332

3433
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.
@@ -39,8 +38,7 @@ You can also skip validating the checksum of the binary by defining the followin
3938
export CODACY_REPORTER_SKIP_CHECKSUM=true
4039
```
4140

42-
## Commit SHA-1 hash detection {: id="commit-detection"}
43-
41+
## Commit SHA-1 hash detection {#commit-detection}
4442
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:
4543

4644
- <span class="skip-vale">Appveyor</span>
@@ -130,8 +128,7 @@ Make sure that your coverage report isn't empty and that it includes coverage da
130128
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.
131129
:::
132130
133-
## Report generated an empty result while uploading C# coverage data {: id="detailedxml"}
134-
131+
## Report generated an empty result while uploading C# coverage data {#detailedxml}
135132
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:
136133

137134
```bash

new-docs/src/content/docs/coverage-reporter/uploading-coverage-in-advanced-scenarios.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ description: Instructions on how to use the Codacy Coverage Reporter to upload c
66

77
The following sections include instructions on how to use the Codacy Coverage Reporter to upload coverage data in more advanced scenarios.
88

9-
## Uploading multiple coverage reports for the same language {: id="multiple-reports"}
10-
9+
## Uploading multiple coverage reports for the same language {#multiple-reports}
1110
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.
1211

1312
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).
@@ -16,8 +15,7 @@ Alternatively, consider merging multiple coverage reports before uploading them
1615
If one or more coverage reports mark a line as covered multiple times, Codacy counts it as a single covered line when calculating coverage.
1716
:::
1817

19-
### Uploading all reports at once {: id="multiple-reports-once"}
20-
18+
### Uploading all reports at once {#multiple-reports-once}
2119
Upload multiple partial coverage reports with a single command by specifying each report with the flag `-r`. For example:
2220

2321
```bash
@@ -32,8 +30,7 @@ bash <(curl -Ls https://coverage.codacy.com/get.sh) report \
3230
-l Java $(find . -name 'jacoco*.xml' | sed 's,^, -r ,' | xargs echo)
3331
```
3432

35-
### Uploading reports in sequence {: id="multiple-reports-sequence"}
36-
33+
### Uploading reports in sequence {#multiple-reports-sequence}
3734
Upload multiple partial coverage reports in sequence:
3835

3936
1. Upload each report <span class="skip-vale">separately</span> with the flag `--partial`.
@@ -52,8 +49,7 @@ bash <(curl -Ls https://coverage.codacy.com/get.sh) report \
5249
bash <(curl -Ls https://coverage.codacy.com/get.sh) final
5350
```
5451

55-
## Uploading the same coverage report for multiple languages {: id="multiple-languages"}
56-
52+
## Uploading the same coverage report for multiple languages {#multiple-languages}
5753
If your test suite generates a single coverage report for more than one language, you must upload the same coverage report for each language.
5854

5955
To do this, upload the same report multiple times, specifying each different language with the flag `-l`. For example:
@@ -66,8 +62,7 @@ bash <(curl -Ls https://coverage.codacy.com/get.sh) report \
6662
bash <(curl -Ls https://coverage.codacy.com/get.sh) final
6763
```
6864

69-
## Uploading coverage for Golang {: id="golang"}
70-
65+
## Uploading coverage for Golang {#golang}
7166
Codacy can't automatically detect Golang coverage report files because they don't have specific file names.
7267

7368
If you're uploading a Golang coverage report, you must also specify the report type:
@@ -78,8 +73,7 @@ bash <(curl -Ls https://coverage.codacy.com/get.sh) report \
7873
--force-coverage-parser go -r unit.coverage.out
7974
```
8075

81-
## Uploading coverage for unsupported languages {: id="unsupported-languages"}
82-
76+
## Uploading coverage for unsupported languages {#unsupported-languages}
8377
If your language isn't in the [list of supported languages](index.md#generating-coverage), you can still send coverage to Codacy.
8478

8579
To do this, provide the correct language with the flag `-l`, together with `--force-language`. For example:

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ Coverage information is currently sent to GitHub by a new version of the Codacy
1212

1313
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).
1414

15-
## Outdated permissions or invalid SSH key {: id="outdated-permissions"}
16-
15+
## Outdated permissions or invalid SSH key {#outdated-permissions}
1716
:::note[This section applies to GitLab and Bitbucket]
1817
:::
1918

new-docs/src/content/docs/getting-started/configuring-your-repository.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ To configure your repository, follow these steps:
2323

2424
![Ignoring files](../repositories-configure/images/ignored-files.png)
2525

26-
## 2. Configuring code patterns {: id="configuring-code-patterns"}
27-
26+
## 2. Configuring code patterns {#configuring-code-patterns}
2827
[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.
2928

3029
:::tip
@@ -33,16 +32,14 @@ To ensure that multiple repositories consistently follow the same global tool an
3332

3433
![Configuring the tools and code patterns](../repositories-configure/images/code-patterns.png)
3534

36-
## 3. Adding coverage to your repository (optional) {: id="adding-coverage"}
37-
35+
## 3. Adding coverage to your repository (optional) {#adding-coverage}
3836
If you want to use code coverage to block merging pull requests that don't meet your quality standards, make sure that you [add coverage to your repository](../coverage-reporter/index.md).
3937

4038
It's important that you set up coverage beforehand because Codacy can only report the coverage status for pull requests after receiving reports for the last commits **on both the pull request branch and the target branch**.
4139

4240
![Adding coverage to your repository](../coverage-reporter/images/coverage-codacy-ui.png)
4341

44-
## Next steps {: id="next-steps"}
45-
42+
## Next steps {#next-steps}
4643
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.
4744

4845
:::tip

new-docs/src/content/docs/getting-started/integrating-codacy-with-your-git-workflow.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ To integrate Codacy with your Git workflow, follow these steps:
1717
1. [Configuring the Git provider integration](#git-provider-integration)
1818
1. [Blocking merging pull requests](#blocking-pull-requests) (optional)
1919

20-
## 1. Configuring the quality gate rules {: id="configuring-gate"}
21-
20+
## 1. Configuring the quality gate rules {#configuring-gate}
2221
[Review and adjust the quality gates](../repositories-configure/adjusting-quality-gates.md) of your repository to decide which pull requests should fail the Codacy quality gate.
2322

2423
:::tip
@@ -38,8 +37,7 @@ Codacy generally recommends that on a first stage you configure rules that focus
3837

3938
![Adjusting the quality gates](../repositories-configure/images/quality-settings-gates.png)
4039

41-
## 2. Configuring the Git provider integration {: id="git-provider-integration"}
42-
40+
## 2. Configuring the Git provider integration {#git-provider-integration}
4341
Make sure you enable the option **Status checks** ([GitHub](../repositories-configure/integrations/github-integration.md#status-checks)) or **Pull request status** ([GitLab](../repositories-configure/integrations/gitlab-integration.md#pull-request-status) and [Bitbucket](../repositories-configure/integrations/bitbucket-integration.md#pull-request-status)).
4442

4543
{%
@@ -50,8 +48,7 @@ Make sure you enable the option **Status checks** ([GitHub](../repositories-conf
5048

5149
![Enabling your Git provider integration](../repositories-configure/integrations/images/github-integration.png)
5250

53-
## 3. Blocking merging pull requests (optional) {: id="blocking-pull-requests"}
54-
51+
## 3. Blocking merging pull requests (optional) {#blocking-pull-requests}
5552
Once you've tested out Codacy for a while and you're happy with the level of feedback provided, you can decide to enforce the quality gates and use Codacy to block merging pull requests on your Git provider. This is the best way to protect your code from unwelcome changes and fully integrate code quality and coverage analysis into your development pipeline.
5653

5754
:::caution

new-docs/src/content/docs/organizations/integrations/default-git-provider-integration-settings.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ To configure these default settings, open your organization **Integrations** pag
1111

1212
The organization-level Git provider integration settings define the defaults that Codacy applies to new repositories. You can then customize the settings for each individual repository, which depend on your Git provider, [GitHub](../../repositories-configure/integrations/github-integration.md), [GitLab](../../repositories-configure/integrations/gitlab-integration.md) or [Bitbucket](../../repositories-configure/integrations/bitbucket-integration.md).
1313

14-
## Applying default settings to all repositories {: id="apply-all"}
15-
14+
## Applying default settings to all repositories {#apply-all}
1615
To ensure that all your repositories are configured with the default Git provider integration settings defined for your organization, click the button **Apply default to all repositories**.
1716

1817
![Apply default settings to all repositories](images/default-git-provider-settings-apply-all.png)

new-docs/src/content/docs/organizations/managing-people.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ To list and manage the people in your organization, open your organization **Set
2323

2424
![People in an organization](images/organization-people.png)
2525

26-
## Joining an organization {: id="joining"}
27-
26+
## Joining an organization {#joining}
2827
To become a member of an organization on Codacy app you must [sign up to Codacy](../getting-started/codacy-quickstart.md) using your Git provider and follow the instructions to either join an existing organization or add a new one.
2928

3029
To join or add an organization after completing the sign-up process, click **Organizations** on the top right-hand menu under your avatar:
@@ -35,8 +34,7 @@ To join or add an organization after completing the sign-up process, click **Org
3534
**On Codacy Cloud**, organization admins [control if team members need an approval](changing-your-plan-and-billing.md#allowing-new-people-to-join-your-organization) before joining their organizations.
3635
:::
3736

38-
## Adding people to your organization {: id="adding-people"}
39-
37+
## Adding people to your organization {#adding-people}
4038
**On Codacy Cloud**, organization admins can also add teammates to their organization on Codacy. This is useful to allow Codacy to analyze commits to private repositories by committers who haven't signed up to Codacy or joined the organization yet.
4139

4240
:::tip
@@ -68,8 +66,7 @@ To add people to your organization:
6866

6967
1. Confirm the updated billing details displayed at the bottom of the window and click the button **Add people**. Codacy emails the newly added people inviting them to log in.
7068

71-
## Removing people from your organization {: id="removing-people"}
72-
69+
## Removing people from your organization {#removing-people}
7370
Members of an organization on Codacy can remove themselves from the organization, and organization admins can also remove other members and committers.
7471

7572
When a member or committer leaves an organization:

new-docs/src/content/docs/organizations/managing-repositories.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ The list also displays error and warning messages for repositories that have iss
2727

2828
If you follow many repositories, you can use the search field above the list to <span class="skip-vale">quickly</span> find a specific repository.
2929

30-
## Adding a repository {: id="adding-a-repository"}
31-
30+
## Adding a repository {#adding-a-repository}
3231
{%
3332
include-markdown "../assets/includes/paid.md"
3433
start="<!--paid-private-repositories-start-->"
@@ -55,8 +54,7 @@ Although Codacy immediately starts analyzing newly added repositories, they disp
5554

5655
![Waiting for first analysis results](images/repositories-analyzing.png)
5756

58-
## Following or unfollowing a repository {: id="follow-unfollow"}
59-
57+
## Following or unfollowing a repository {#follow-unfollow}
6058
Users with [no permission to add a repository](roles-and-permissions-for-organizations.md) to Codacy, can follow that repository after it has been added to Codacy, and stop following it at any time.
6159

6260
To follow or unfollow repositories on Codacy:
@@ -76,8 +74,7 @@ Conversely, you automatically **stop following** a repository as soon as you try
7674

7775
:::
7876

79-
## Finding your repositories with Segments {: id="provider-segments"}
80-
77+
## Finding your repositories with Segments {#provider-segments}
8178
Codacy allows you to utilise [**Segments**](../segments) to categorize and filter repositories more effectively within the Codacy platform.
8279
:::note[Check out how to [enable and configure **Segments**](../segments/#enabling-segments)]
8380
:::

0 commit comments

Comments
 (0)