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
Added "Segments" documentation with content updates, link corrections, and image adjustments. Updated SRM page filter, security, and repositories docs, along with general formatting and configuration tweaks.
---------
Co-authored-by: Jorge Braz <jorge.braz@codacy.com>
Copy file name to clipboardExpand all lines: docs/organizations/managing-repositories.md
+6-16Lines changed: 6 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,29 +68,19 @@ To follow or unfollow repositories on Codacy:
68
68
You automatically **start following** a repository as soon as you access any page from that repository. For example, when you access the repository using a direct link on your Git provider UI.
69
69
70
70
Conversely, you automatically **stop following** a repository as soon as you try accessing any page from that repository but you don't have permissions to see that repository anymore.
71
+
72
+
## Finding your repositories with Segments {: id="provider-segments"}
Codacy allows you to filter repositories based on **Repository Custom Properties** from GitHub. This feature helps you to categorize and filter repositories more effectively within the Codacy platform.
74
+
Codacy allows you to utilise [**Segments**](../segments) to categorize and filter repositories more effectively within the Codacy platform.
75
+
!!! info "Check out how to [enable and configure **Segments**](../segments/#enabling-segments)"
75
76
76
77

77
78
78
-
To enable this feature, users must go through an **initial sync** between GitHub and Codacy, which ensures that the repository custom properties from GitHub are reflected in Codacy.
79
79
80
80

81
81
82
-
!!! important
83
-
For changes to **Repository Custom Properties** in GitHub to be **automatically** reflected in Codacy, users need to [accept the new permission request made by the Codacy GitHub app](https://docs.github.com/en/apps/using-github-apps/approving-updated-permissions-for-a-github-app). Accepting this permission enables automatic synchronization of any future changes to the custom properties in GitHub.
84
-
85
-
If the permission is **not accepted**, users will still be able to use Repository Custom Properties as filters in Codacy, but will need to manually trigger a sync. This can be done using the **manual sync** button available in the filter dropdown, which allows users to synchronize changes from GitHub, though the process may take longer.
86
82
87
-
Once the sync is completed, you can use these custom properties as a filter to better locate and organize repositories within Codacy.
88
-
89
-
!!! note
90
-
To fully take advantage of this feature, you can create, use, and manage custom properties for your repositories directly in GitHub. Custom properties allow you to assign tags or metadata to repositories, making it easier to categorize and filter them.
91
-
92
-
For detailed steps on how to add, edit, and manage **Repository Custom Properties** in GitHub, refer to [GitHub's official documentation](https://docs.github.com/en/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization#adding-custom-properties).
93
83
94
84
## See also
95
-
96
-
-[Which metrics does Codacy calculate?](../faq/code-analysis/which-metrics-does-codacy-calculate.md)
85
+
-[How to setup Segments?](../segments)
86
+
-[Which metrics does Codacy calculate?](../faq/code-analysis/which-metrics-does-codacy-calculate.md)
-[Top 10 common security categories](#top-10-common-security-categories)
30
30
31
-
To limit the information displayed in each panel to a specific set of repositories, use the filter drop-down above the main area.
31
+
To limit the information displayed in each panel, use the filter drop-down above the main area, and choose the relevant repositories, or utilise [**Segments**](../segments).
32
+
!!! info "Check out how to [enable and configure **Segments**](../segments/#enabling-segments)"
33
+
32
34
33
35
### Open findings overview
34
36
@@ -91,7 +93,8 @@ To access the findings page, access the [overview page](#dashboard) and click th
91
93
92
94

93
95
94
-
When viewing the findings, you can update the filtering criteria by clicking the **Severity**, **Status**, **Repository**, **Security category**, or **Scan type** drop-downs above the list.
96
+
When viewing the findings, you can update the filtering criteria by clicking the [**Segments**](../segments) , **Repository**, **Severity**, **Status**, **Security category**, or **Scan type** drop-downs above the list.
97
+
!!! info "Check out how to [enable and configure **Segments**](../segments/#enabling-segments)"
95
98
96
99
The **Details** column offers a quick overview of each finding in the list, including its title, [source platform](#opening-and-closing-items), [scan type](#scan-types), [security category](#supported-security-categories), and related information such as the repository name, Jira issue key, or penetration testing report URL. To find out more, click this overview to navigate to the finding details on the source platform.
97
100
@@ -101,6 +104,8 @@ The **Details** column offers a quick overview of each finding in the list, incl
101
104
102
105
To share the current view of the overview or findings page, click the **Copy URL** button in the top right-hand corner of the page. This action copies the URL with the current filters applied to the clipboard.
103
106
107
+
!!! Important " [**Segments**](../segments) filter won't be considered when sharing the filtered view"
Segments are dimensions that Codacy reads from your provider that organizes repositories into relevant groups for you. Today, Segments is available for: [GitHub Custom Properties](#github-custom-properties)
To enable Segments, an initial sync between your provider and Codacy needs to happen. Once completed, you can use Segments to better locate and organize repositories within Codacy.
Create, use, and manage custom properties for your repositories directly in GitHub. Custom properties allow you to assign tags or metadata to repositories, making it easier to categorize and filter them.
18
+
19
+
> Refer to [GitHub's official documentation](https://docs.github.com/en/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization#adding-custom-properties) for detailed steps on how to add, edit, and manage repository **Custom Properties**.
20
+
21
+
#### Keep Segments in sync
22
+
For changes to repository **Custom Properties** in GitHub to be **automatically** reflected in Codacy, users need to [accept the new permission request made by the Codacy GitHub app](https://docs.github.com/en/apps/using-github-apps/approving-updated-permissions-for-a-github-app).
23
+
!!! note
24
+
If the permission is **not accepted**, users will still be able to use Repository Custom Properties as filters in Codacy, but will need to manually trigger a sync. This can be done using the **manual sync** button available in the filter dropdown, which allows users to synchronize changes from GitHub, though the process may take longer.
0 commit comments