Skip to content

Commit 51d6833

Browse files
Segments GitHub SRM PLUTO-1072 (#2214)
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>
1 parent 464dfee commit 51d6833

11 files changed

+50
-18
lines changed
112 KB
Loading
39.8 KB
Loading
132 KB
Loading
-2.31 KB
Loading
68 KB
Loading
152 KB
Loading
173 KB
Loading

docs/organizations/managing-repositories.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -68,29 +68,19 @@ To follow or unfollow repositories on Codacy:
6868
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.
6969

7070
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"}
7173

72-
## Repository Custom Properties Filter {: id="custom-properties-filter"}
73-
74-
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)"
7576

7677
![Repositories list filter](images/organization-manage-repos-custom-properties.png)
7778

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.
7979

8080
![Repositories list sync](images/organization-manage-repos-custom-properties-sync.png)
8181

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.
8682

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).
9383

9484
## 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)

docs/organizations/managing-security-and-risk.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ The overview page includes six panels:
2828
- [Top 10 high-risk repositories](#top-10-high-risk-repositories)
2929
- [Top 10 common security categories](#top-10-common-security-categories)
3030

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+
3234

3335
### Open findings overview
3436

@@ -91,7 +93,8 @@ To access the findings page, access the [overview page](#dashboard) and click th
9193

9294
![Security and risk management findings page](images/security-risk-management-findings.png)
9395

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)"
9598

9699
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.
97100

@@ -101,6 +104,8 @@ The **Details** column offers a quick overview of each finding in the list, incl
101104

102105
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.
103106

107+
!!! Important " [**Segments**](../segments) filter won't be considered when sharing the filtered view"
108+
104109
## Exporting findings {: id="exporting-the-security-item-list"}
105110

106111
!!! info "This feature is available only to organization admins and organization managers"

docs/organizations/segments.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Segments
2+
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)
3+
4+
5+
## Where can Segments be utilised?
6+
- [Repository list](../managing-repositories/#provider-segments)
7+
- [Security & Management Risk](../managing-security-and-risk/)
8+
9+
## Enabling Segments {: id="enabling-segments"}
10+
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.
11+
![Segments sync](../organizations/images/Segments-no-sync.png)
12+
![Segments after sync](../organizations/images/segments-after-sync.png)
13+
<br><br>
14+
15+
16+
### GitHub Custom Properties {: id="github-custom-properties"}
17+
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.
25+
26+
<br><br>
27+
***
28+
#### Check out what's new, and to come, in Codacy
29+
<div>
30+
<iframe id="inlineRoadmap"
31+
title="Codacy Roadmap"
32+
width="100%"
33+
height="472"
34+
src="https://portal.productboard.com/2ng56ct2oir3adgbkvzfgqks" frameborder="0" >
35+
</iframe>
36+
</div>

0 commit comments

Comments
 (0)