Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Segments GitHub SRM PLUTO-1072 #2214

Merged
merged 45 commits into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
160aea8
Segments filter in SRM page
RaquelHipolito Oct 4, 2024
14ba52e
update text component
RaquelHipolito Oct 4, 2024
45306f5
Update managing-security-and-risk.md
RaquelHipolito Oct 4, 2024
72faa96
Update managing-security-and-risk.md
RaquelHipolito Oct 4, 2024
54eeeaa
Add segments doc page
RaquelHipolito Oct 4, 2024
6bd0429
Update managing-security-and-risk.md
RaquelHipolito Oct 4, 2024
dea9c0e
adding segments page
RaquelHipolito Oct 4, 2024
44628e8
Segments page content add
RaquelHipolito Oct 4, 2024
6834254
titles sizes
RaquelHipolito Oct 4, 2024
85bc7c0
Update segments.md
RaquelHipolito Oct 4, 2024
f81d0db
Update segments.md
RaquelHipolito Oct 4, 2024
c00a9d1
Update segments.md
RaquelHipolito Oct 4, 2024
9ba3d57
Update segments.md
RaquelHipolito Oct 4, 2024
81fe269
Update segments.md
RaquelHipolito Oct 4, 2024
d060f41
Update mkdocs.yml
RaquelHipolito Oct 4, 2024
eee744f
Update segments.md
RaquelHipolito Oct 4, 2024
48fa341
Update segments.md
RaquelHipolito Oct 4, 2024
07ce28e
will not > won't
RaquelHipolito Oct 4, 2024
ca1ecd8
spelling correction
RaquelHipolito Oct 4, 2024
2490923
Update segments.md
RaquelHipolito Oct 4, 2024
4e855aa
Update segments.md
RaquelHipolito Oct 4, 2024
efc6673
Update segments.md
RaquelHipolito Oct 4, 2024
adcc820
Update managing-security-and-risk.md
RaquelHipolito Oct 4, 2024
9d22055
Update managing-repositories.md
RaquelHipolito Oct 4, 2024
db3b680
Update segments.md
RaquelHipolito Oct 4, 2024
6f85fdd
correcting segments.md link path
RaquelHipolito Oct 9, 2024
58c010e
/organizations/
RaquelHipolito Oct 9, 2024
28d5d22
Update managing-repositories.md
jorgebraz Oct 9, 2024
a3fc4b8
Update segments.md
RaquelHipolito Oct 9, 2024
4628ecc
Update managing-repositories.md
RaquelHipolito Oct 9, 2024
5dc340a
Update managing-security-and-risk.md
RaquelHipolito Oct 9, 2024
5c3dd1d
Update segments.md
RaquelHipolito Oct 9, 2024
61ae550
Update managing-security-and-risk.md
RaquelHipolito Oct 9, 2024
92de4ba
Update managing-repositories.md
RaquelHipolito Oct 9, 2024
1a28e96
testing local setup
RaquelHipolito Oct 9, 2024
d89cf43
adding and updating images for segments
RaquelHipolito Oct 9, 2024
4e9eaa0
correcting images
RaquelHipolito Oct 9, 2024
97f3259
crop image
RaquelHipolito Oct 9, 2024
7ef19f7
images and caps
RaquelHipolito Oct 9, 2024
6366f90
update wording
RaquelHipolito Oct 10, 2024
1cc355b
addressing feedback: images
RaquelHipolito Oct 10, 2024
4ead91c
testing page bracking
RaquelHipolito Oct 10, 2024
e2f2cd4
testing page breaking II
RaquelHipolito Oct 10, 2024
b52c322
final changes
RaquelHipolito Oct 10, 2024
3b756cc
last try with roadmap
RaquelHipolito Oct 10, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/repositories.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 6 additions & 16 deletions docs/organizations/managing-repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,29 +68,19 @@ To follow or unfollow repositories on Codacy:
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.

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.

## Finding your repositories with Segments {: id="provider-segments"}
RaquelHipolito marked this conversation as resolved.
Show resolved Hide resolved

## Repository Custom Properties Filter {: id="custom-properties-filter"}

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.
Codacy allows you to utilise [**Segments**](../segments) to categorize and filter repositories more effectively within the Codacy platform.
!!! info "Check out how to [enable and configure **Segments**](../segments/#enabling-segments)"

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

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.

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

!!! important
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.

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.

Once the sync is completed, you can use these custom properties as a filter to better locate and organize repositories within Codacy.

!!! note
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.

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

## See also

- [Which metrics does Codacy calculate?](../faq/code-analysis/which-metrics-does-codacy-calculate.md)
- [How to setup Segments?](../segments)
- [Which metrics does Codacy calculate?](../faq/code-analysis/which-metrics-does-codacy-calculate.md)
9 changes: 7 additions & 2 deletions docs/organizations/managing-security-and-risk.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ The overview page includes six panels:
- [Top 10 high-risk repositories](#top-10-high-risk-repositories)
- [Top 10 common security categories](#top-10-common-security-categories)

To limit the information displayed in each panel to a specific set of repositories, use the filter drop-down above the main area.
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).
!!! info "Check out how to [enable and configure **Segments**](../segments/#enabling-segments)"

RaquelHipolito marked this conversation as resolved.
Show resolved Hide resolved

### Open findings overview

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

![Security and risk management findings page](images/security-risk-management-findings.png)
RaquelHipolito marked this conversation as resolved.
Show resolved Hide resolved

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.
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.
RaquelHipolito marked this conversation as resolved.
Show resolved Hide resolved
!!! info "Check out how to [enable and configure **Segments**](../segments/#enabling-segments)"

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.

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

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.

!!! Important " [**Segments**](../segments) filter won't be considered when sharing the filtered view"

## Exporting findings {: id="exporting-the-security-item-list"}

!!! info "This feature is available only to organization admins and organization managers"
Expand Down
36 changes: 36 additions & 0 deletions docs/organizations/segments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Segments
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)


## Where can Segments be utilised?
- [Repository list](../managing-repositories/#provider-segments)
- [Security & Management Risk](../managing-security-and-risk/)

## Enabling Segments {: id="enabling-segments"}
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.
![Segments sync](../organizations/images/Segments-no-sync.png)
![Segments after sync](../organizations/images/segments-after-sync.png)
<br><br>
RaquelHipolito marked this conversation as resolved.
Show resolved Hide resolved
RaquelHipolito marked this conversation as resolved.
Show resolved Hide resolved


### GitHub Custom Properties {: id="github-custom-properties"}
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.

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

#### Keep Segments in sync
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).
!!! note
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.

<br><br>
RaquelHipolito marked this conversation as resolved.
Show resolved Hide resolved
***
RaquelHipolito marked this conversation as resolved.
Show resolved Hide resolved
#### Check out what's new, and to come, in Codacy
<div>
<iframe id="inlineRoadmap"
title="Codacy Roadmap"
width="100%"
height="472"
src="https://portal.productboard.com/2ng56ct2oir3adgbkvzfgqks" frameborder="0" >
</iframe>
</div>
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -598,6 +598,7 @@ nav:
- organizations/what-are-organizations.md
- organizations/organization-overview.md
- organizations/managing-repositories.md
- organizations/segments.md
- organizations/using-gate-policies.md
- organizations/using-coding-standards.md
- Managing integrations:
Expand Down
Loading