Skip to content

Commit b4044eb

Browse files
Merge branch 'master' into new-doc-framework--its-xmas-baby
2 parents bd2de9b + f4a6025 commit b4044eb

33 files changed

Lines changed: 447 additions & 35 deletions

.github/workflows/mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ jobs:
1010
runs-on: ubuntu-latest
1111
steps:
1212
- name: Checkout code
13-
uses: actions/checkout@v4
13+
uses: actions/checkout@v6
1414
with:
15-
token: ${{ secrets.DEPLOYMENT_PERSONAL_ACCESS_TOKEN }}
15+
token: ${{ secrets.GITHUB_TOKEN }}
1616
submodules: true
1717
# git-revision-date-localized-plugin and mkdocs-rss-plugin need full git history depth
1818
fetch-depth: 0
@@ -96,7 +96,7 @@ jobs:
9696
uses: peaceiris/actions-gh-pages@v4
9797
if: github.ref == 'refs/heads/master'
9898
with:
99-
personal_token: ${{ secrets.DEPLOYMENT_PERSONAL_ACCESS_TOKEN }}
99+
github_token: ${{ secrets.GITHUB_TOKEN }}
100100
publish_dir: ./site
101101
destination_dir: ./
102102
keep_files: true

docs/enterprise-cloud/github-enterprise-cloud.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,56 @@
11
# GitHub Enterprise Cloud
22

3-
Use your GitHub Enterprise credentials when signup or login to Codacy and all your GitHub Enterprise organizations that you belong to, will be available to be added as Organizations on Codacy.
3+
Use your GitHub Enterprise credentials when signing up or logging in to Codacy and all your GitHub Enterprise organizations that you belong to, will be available to be added as Organizations on Codacy.
44

5-
Codacy also has a dedicated Enterprise area where GitHub Enterprise admins and owners of the enterprise will be able to manage them.
5+
Codacy also has a dedicated Enterprise area where GitHub Enterprise admins and owners of the enterprise will be able to manage their respective organizations.
66

77
### GitHub Enterprise types
8-
Codacy supports both [GitHub Enterprises types](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/choosing-an-enterprise-type-for-github-enterprise-cloud), Managed Users and Personal Accounts.
8+
Codacy supports both [GitHub Enterprise types](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/choosing-an-enterprise-type-for-github-enterprise-cloud), Managed Users and Personal Accounts.
99

1010
## Access cloud Enterprises
11-
Access you enterprises in Codacy by setting up its integration:
11+
Access your Enterprises in Codacy by setting up its integration:
1212

13-
1. In codacy app, click on your avatar image, in the top right corner
14-
1. then navigate throught "My account" and "Access management"
13+
1. In Codacy, click on your avatar, in the top right corner
14+
2. Navigate through "My account" and "Access management"
1515
1. There, you'll be able to add a **GitHub Enterprise Cloud** access token.
1616

17-
Once generated and added in Codacy you will start seeing all infomration you have access to regarding your cloud enterprises.
18-
You can revoke the cloud enterpises access at any time in the same place.
17+
Once generated and added in Codacy you will start seeing all the information you have access to regarding your Cloud Enterprises.
18+
You can revoke the Cloud Enterpises' access at any time in the same place.
1919
![Enterprise cloud manage enterprises access](images/Codacy-Access-Management.png)
2020

2121

2222
## Manage Enterprises
2323
- [Enterprise organizations list](#enterprise-organizations-list)
2424
- [Seats management](#seats)
25-
- [Enterprise Limitations](#limitations)
25+
- [Enterprise limitations](#limitations)
2626

27-
Once signup or login with your GitHub Enterprise credentials and, [setup access to could enterprises](#access-cloud-enterprises), navigate to your Enterprises area to manage your enterprises in Codacy, as well its organizations and seats management.
27+
Once you sign up or log in with your GitHub Enterprise credentials and, [set up access to Cloud Enterprise](#access-cloud-enterprises), navigate to your Enterprise area to manage your Enterprises in Codacy, as well as its organizations and seats management.
2828

2929
!!! note
3030
If you only have one Enterprise, Codacy will skip this screen and directs you to the [enterprise organizations list](#enterprise-organizations-list).
3131

3232
![Enterprise cloud manage enterprises](images/Codacy-Enterprises.png)
3333

3434
### Enterprise organizations list
35-
Choose to view a enterprise and access its list of existing organizations, that you have access to.
35+
Select an Enterprise and access its list of existing organizations that you have access to.
3636
![Enterprise cloud manage organizations](images/Codacy-Enterprise-Organizations.png)
3737

3838
### Seats
39-
View and export your enterprise seats and its activity by:
39+
View and export your Enterprise seats and its activity by:
4040

41-
1. Choose and view an enterprise organization
42-
1. Navigate to **People** on the left-handside navigation
41+
1. Choose and view an Enterprise organization
42+
1. Navigate to **People** on the left-hand side navigation
4343
1. View, search and export the list of author seats
4444

4545
!!! note
46-
- Codacy members won't be part of this list, only authors, users that have done commits.
47-
- In some Enterprise plans, **Members** are people that signup and joined an Organization in Codacy, and **Authors** are people that contribute to code changes. It can happen that Authors aren't Codacy Members.
46+
- Codacy members won't be part of this list; only authors and users that have committed.
47+
- In some Enterprise plans, **Members** are people that signed up and joined an Organization in Codacy, and **Authors** are people that contribute to code changes. It can happen that Authors aren't Codacy Members.
4848
- Only Enterprise **Owners** or **Admins** will be able to view and export the list of authors.
4949

5050
### Limitations
5151
Currently, the integration between Codacy and GitHub Enterprise has the following limitations:
5252

53-
- **Repositories with visibility Internal** will, in Codacy, have the same behavior as Private visibility. Although you see the repository in the provider, if you aren't part of the repository in the provider, you won't be able to see it in Codacy.
53+
- **Repositories with visibility set to Internal** will, in Codacy, have the same behavior as those with Private visibility. Although you see the repository in the provider, if you aren't part of the repository in the provider, you won't be able to see it in Codacy.
5454
- **Same email connected to multiple GitHub accounts.** Codacy won't allow you to connect your enterprise account if that email is already associated with a different GitHub account. You can manage your [associated emails in the provider GitHub](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account).
5555
- **GitHub Cloud data residency is not supported.** Codacy is incompatible with GitHub Enterprise Cloud's data residency features. If your GitHub Enterprise Cloud has data residency enabled, Codacy won't be able to access or process your repositories.
5656

docs/getting-started/codacy-quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ nav_step: 0
77

88
Codacy is an automated code quality and coverage platform that analyzes your source code and identifies issues as you go, helping your team ship robust software by scanning over 40 programming languages, such as JavaScript, Python, Java, C#, and PHP.
99

10-
Check out our product demo for an overview of Codacy's main features (recorded on May 13, 2024):
10+
Check out our product demo for an overview of Codacy's main features (recorded on November, 2025):
1111

12-
<div style="position: relative; padding-bottom: 61.224489795918366%; height: 0;"><iframe src="https://www.loom.com/embed/1ed27d66b659427883ddd28e57468c22" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
12+
<div style="position: relative; padding-bottom: 61.224489795918366%; height: 0;"><iframe src="https://www.loom.com/embed/b4dbb1342309493c8e34097e9e797549" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
1313

1414
By integrating with your Git provider, Codacy keeps track of your team’s work, analyzes relevant commits, highlights problems, suggests improvements, and protects your codebase from unwelcome changes. From organization and repository level to individual files, pull requests, and commits, Codacy monitors the following metrics across your projects:
1515

docs/getting-started/configuring-your-repository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To configure your repository, follow these steps:
1919

2020
## 1. Ignoring files {: id="ignoring-files"}
2121

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.md) that aren't relevant for the Codacy analysis, such as generated code or any third-party libraries included in your repositories. Learn more about [Ignoring files](../repositories-configure/ignoring-files.md).
2323

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

docs/organizations/codacy-usage.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Codacy usage
2+
3+
The **Codacy usage** dashboard provides an overview of your organization's configurations and their impact. You can filter repositories by quality gates and coverage, select specific repositories, or use [the segments that you have set up](segments.md).
4+
5+
![Codacy usage dashboard](images/codacy-usage-dashboard.png)
6+
7+
!!! important
8+
The repositories **not in Codacy** metric is only available to GitHub accounts.
9+
10+
To view the **Codacy usage** dashboard:
11+
12+
- Select an organization from the top navigation bar.
13+
- On the organization overview page, click the Codacy usage tab.
14+
15+
The **Codacy usage dashboard** includes the following sections/charts to help you monitor Codacy adoption:
16+
17+
- [Repositories](#repositories)
18+
- [Repositories evolution](#repositories-evolution)
19+
- [Merged pull requests](#merged-pull-requests)
20+
- [Repositories list](#repositories-list)
21+
22+
!!! tip
23+
In each section, you can click on the ellipsis icon in the top right corner to export that section's data to CSV or JSON.
24+
25+
## Repositories
26+
27+
This chart displays the distribution of repositories that are and are not in Codacy. The doughnut chart also details the breakdown of Codacy repositories based on their configurations: those without quality gates, without coverage, without either gates or coverage, and those with both gates and coverage. Users can interact with the doughnut chart or the numerical data to filter the results. Applying a filter will also affect the repositories displayed in the evolution chart and the results will appear in the **Repositories list**.
28+
29+
!!! note
30+
Repository coverage data is based on the last merged pull request, meaning that if a repository has coverage setup but coverage was not sent in the last merged PR, it will not count as a repository with Coverage.
31+
32+
![Repositories distribution](images/repositories-distribution.png)
33+
34+
## Repositories evolution
35+
36+
This chart shows the trend of repositories in your organization over time, considering the filters applied, affecting the **Repositories list**. You can hover over the chart to see the number of repositories on a specific date. You can also click on the chart to filter results.
37+
38+
![Repositories evolution](images/repositories-evolution.png)
39+
40+
## Merged pull requests
41+
42+
This chart tracks the total volume of pull requests merged across your Codacy-managed repositories. It serves as a high-level health check to ensure that your team's development velocity is aligned with your quality standards.
43+
Interacting with the chart allows you to filter the data, with the resulting repositories displayed in the **Repositories list**.
44+
45+
### Understanding the categories
46+
47+
- Passing Gates: These PRs met all your quality standards (e.g., coverage, complexity, security) before being merged.
48+
- Failing Gates: PRs merged despite failing one or more quality checks.
49+
- Without Gates: PRs merged into repositories where no quality gates are configured.
50+
- Never Analyzed: PRs that reached a "Merged" status without Codacy completing an analysis.
51+
52+
#### Why are some PRs "Never analyzed"?
53+
54+
If you see high numbers here, it usually boils down to two scenarios:
55+
56+
1. A developer merged the PR immediately after opening it, before the Codacy analysis could finish. To improve this, ensure your team adjusts their workflow to wait for the "Codacy/Analysis" check to turn green before merging or by making the Codacy status check mandatory.
57+
58+
2. In organizations with manual user management (check your billing settings), if a PR is authored by an email/user not yet added to your Codacy seat count, the analysis may be skipped. You should check your [seat management](../organizations/managing-people.md) to confirm that all active contributors are correctly mapped to a Codacy seat.”
59+
60+
61+
#### Why are some PRs merged with "Failing gates"?
62+
63+
Pull requests are merged with failing Quality Gates usually due to two reasons:
64+
65+
1. Quality Gates are advisory, not blocking. [Protect your pull requests](../getting-started/integrating-codacy-with-your-git-workflow.md#blocking-pull-requests).
66+
67+
2. Intentional exceptions or risk acceptance:
68+
- Developers/maintainers may override failing checks to address urgent fixes, unblock critical work, or accept a known risk temporarily.
69+
70+
- Sometimes pull requests are small and diff coverage / coverage variation may fail. Make sure your team follows the practices that were agreed upon within the organization.
71+
72+
Interacting with the chart allows you to filter the data, with the resulting repositories displayed in the **Repositories list**.
73+
74+
!!! note
75+
Merged pull requests data is only from repositories that are in Codacy.
76+
77+
![Merged pull requests](images/merged-pull-requests.png)
78+
79+
## Repositories list
80+
81+
The list shows a maximum of 10 repositories from your Git provider. You can use filters to display repositories that aren't yet in Codacy, or repositories that are already in Codacy. For repositories in Codacy, the list can also group them by specific metrics such as gates, coverage, and merged pull request information. Despite the 10 repository limit, the Repositories list section allows you to download a list up to 100 repositories.
82+
83+
![Repositories list](images/repositories-list.png)
142 KB
Loading
52.3 KB
Loading
33.3 KB
Loading
38.1 KB
Loading
39.1 KB
Loading

0 commit comments

Comments
 (0)