diff --git a/docs/organizations/images/Segments-no-sync.png b/docs/organizations/images/Segments-no-sync.png new file mode 100644 index 0000000000..d400e7a3cd Binary files /dev/null and b/docs/organizations/images/Segments-no-sync.png differ diff --git a/docs/organizations/images/repositories.png b/docs/organizations/images/repositories.png index f6670fe570..c410e2cda3 100644 Binary files a/docs/organizations/images/repositories.png and b/docs/organizations/images/repositories.png differ diff --git a/docs/organizations/images/security-risk-management-findings-segments.png b/docs/organizations/images/security-risk-management-findings-segments.png new file mode 100644 index 0000000000..e67b597c3d Binary files /dev/null and b/docs/organizations/images/security-risk-management-findings-segments.png differ diff --git a/docs/organizations/images/security-risk-management-findings.png b/docs/organizations/images/security-risk-management-findings.png index 064fcc75ed..e6550d2602 100644 Binary files a/docs/organizations/images/security-risk-management-findings.png and b/docs/organizations/images/security-risk-management-findings.png differ diff --git a/docs/organizations/images/security-risk-management-overview.png b/docs/organizations/images/security-risk-management-overview.png index 10d706ead4..3f378db23a 100644 Binary files a/docs/organizations/images/security-risk-management-overview.png and b/docs/organizations/images/security-risk-management-overview.png differ diff --git a/docs/organizations/images/security-risk-management-segments-overview.png b/docs/organizations/images/security-risk-management-segments-overview.png new file mode 100644 index 0000000000..933e18f38f Binary files /dev/null and b/docs/organizations/images/security-risk-management-segments-overview.png differ diff --git a/docs/organizations/images/segments-after-sync.png b/docs/organizations/images/segments-after-sync.png new file mode 100644 index 0000000000..1a80479efc Binary files /dev/null and b/docs/organizations/images/segments-after-sync.png differ diff --git a/docs/organizations/managing-repositories.md b/docs/organizations/managing-repositories.md index 4dbfd8f066..473e3377eb 100644 --- a/docs/organizations/managing-repositories.md +++ b/docs/organizations/managing-repositories.md @@ -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"} -## 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) diff --git a/docs/organizations/managing-security-and-risk.md b/docs/organizations/managing-security-and-risk.md index b2971ea1c7..b1b1005432 100644 --- a/docs/organizations/managing-security-and-risk.md +++ b/docs/organizations/managing-security-and-risk.md @@ -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)" + ### Open findings overview @@ -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) -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. +!!! 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. @@ -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" diff --git a/docs/organizations/segments.md b/docs/organizations/segments.md new file mode 100644 index 0000000000..a901e846a1 --- /dev/null +++ b/docs/organizations/segments.md @@ -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) +

+ + +### 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. + +

+*** +#### Check out what's new, and to come, in Codacy +
+ +
\ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index d41f60857a..7066b8ffb6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: