From 160aea800a67fe355ae5f0988bcdd8d07866644f Mon Sep 17 00:00:00 2001 From: Raquel <25031075+RaquelHipolito@users.noreply.github.com> Date: Fri, 4 Oct 2024 11:20:47 +0100 Subject: [PATCH 01/45] Segments filter in SRM page --- .../managing-security-and-risk.md | 24 +++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/docs/organizations/managing-security-and-risk.md b/docs/organizations/managing-security-and-risk.md index b2971ea1c7..a667f92326 100644 --- a/docs/organizations/managing-security-and-risk.md +++ b/docs/organizations/managing-security-and-risk.md @@ -28,7 +28,18 @@ 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 to a specific set of repositories, use the filter drop-down above the main area. Choose the relevant repositories or utilise **Segments** to filter repositories based on Repository Custom Properties from GitHub. + +To enable **Segments**, an initial sync between GitHub and Codacy needs to happen, which ensures that the repository custom properties from GitHub are reflected in Codacy. Once completed, you can use your custom properties as a **Segments** filter to better locate and organize repositories within Codacy. + + 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). + +!!! 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. + + ### Open findings overview @@ -91,7 +102,16 @@ 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**, **Repository**, **Severity**, **Status**, **Security category**, or **Scan type** drop-downs above the list. + +**Segments** will filter repositories based on Repository Custom Properties from GitHub. + + To enable **Segments**, an initial sync between GitHub and Codacy needs to happen, which ensures that the repository custom properties from GitHub are reflected in Codacy. Once completed, you can use your custom properties as a **Segments** filter to better locate and organize repositories within Codacy. + +!!! 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. 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. From 14ba52e8e887c926b669d70c5d2e2f6ccc03e793 Mon Sep 17 00:00:00 2001 From: Raquel <25031075+RaquelHipolito@users.noreply.github.com> Date: Fri, 4 Oct 2024 11:24:30 +0100 Subject: [PATCH 02/45] update text component --- docs/organizations/managing-security-and-risk.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/organizations/managing-security-and-risk.md b/docs/organizations/managing-security-and-risk.md index a667f92326..321f38eeb4 100644 --- a/docs/organizations/managing-security-and-risk.md +++ b/docs/organizations/managing-security-and-risk.md @@ -30,6 +30,7 @@ The overview page includes six panels: To limit the information displayed in each panel to a specific set of repositories, use the filter drop-down above the main area. Choose the relevant repositories or utilise **Segments** to filter repositories based on Repository Custom Properties from GitHub. +!!note To enable **Segments**, an initial sync between GitHub and Codacy needs to happen, which ensures that the repository custom properties from GitHub are reflected in Codacy. Once completed, you can use your custom properties as a **Segments** filter to better locate and organize repositories within Codacy. 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). From 45306f5231b7f6de970321b49dbbd96e64ff51b3 Mon Sep 17 00:00:00 2001 From: Raquel <25031075+RaquelHipolito@users.noreply.github.com> Date: Fri, 4 Oct 2024 11:26:29 +0100 Subject: [PATCH 03/45] Update managing-security-and-risk.md --- docs/organizations/managing-security-and-risk.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/organizations/managing-security-and-risk.md b/docs/organizations/managing-security-and-risk.md index 321f38eeb4..90868ab186 100644 --- a/docs/organizations/managing-security-and-risk.md +++ b/docs/organizations/managing-security-and-risk.md @@ -30,7 +30,7 @@ The overview page includes six panels: To limit the information displayed in each panel to a specific set of repositories, use the filter drop-down above the main area. Choose the relevant repositories or utilise **Segments** to filter repositories based on Repository Custom Properties from GitHub. -!!note +!!! note To enable **Segments**, an initial sync between GitHub and Codacy needs to happen, which ensures that the repository custom properties from GitHub are reflected in Codacy. Once completed, you can use your custom properties as a **Segments** filter to better locate and organize repositories within Codacy. 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). From 72faa96b385cb70a4b5b50e417aaf5444041c212 Mon Sep 17 00:00:00 2001 From: Raquel <25031075+RaquelHipolito@users.noreply.github.com> Date: Fri, 4 Oct 2024 11:28:19 +0100 Subject: [PATCH 04/45] Update managing-security-and-risk.md --- docs/organizations/managing-security-and-risk.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/organizations/managing-security-and-risk.md b/docs/organizations/managing-security-and-risk.md index 90868ab186..d78d910679 100644 --- a/docs/organizations/managing-security-and-risk.md +++ b/docs/organizations/managing-security-and-risk.md @@ -31,8 +31,8 @@ The overview page includes six panels: To limit the information displayed in each panel to a specific set of repositories, use the filter drop-down above the main area. Choose the relevant repositories or utilise **Segments** to filter repositories based on Repository Custom Properties from GitHub. !!! note -To enable **Segments**, an initial sync between GitHub and Codacy needs to happen, which ensures that the repository custom properties from GitHub are reflected in Codacy. Once completed, you can use your custom properties as a **Segments** filter to better locate and organize repositories within Codacy. - + To enable **Segments**, an initial sync between GitHub and Codacy needs to happen, which ensures that the repository custom properties from GitHub are reflected in Codacy. Once completed, you can use your custom properties as a **Segments** filter to better locate and organize repositories within Codacy. + 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). !!! important From 54eeeaa05a27e0d964412c5a35de3fbfd34c7ccb Mon Sep 17 00:00:00 2001 From: Raquel <25031075+RaquelHipolito@users.noreply.github.com> Date: Fri, 4 Oct 2024 12:02:16 +0100 Subject: [PATCH 05/45] Add segments doc page --- docs/organizations/segments | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 docs/organizations/segments diff --git a/docs/organizations/segments b/docs/organizations/segments new file mode 100644 index 0000000000..186f6a153d --- /dev/null +++ b/docs/organizations/segments @@ -0,0 +1,2 @@ +Collect all info about Segments to reduce repetition and distraction - later we'll add more providers as well and need to comunicate intructions. + From 6bd0429733799df18cbfcbe3bdf518b2e529e819 Mon Sep 17 00:00:00 2001 From: Raquel <25031075+RaquelHipolito@users.noreply.github.com> Date: Fri, 4 Oct 2024 12:05:20 +0100 Subject: [PATCH 06/45] Update managing-security-and-risk.md --- docs/organizations/managing-security-and-risk.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/organizations/managing-security-and-risk.md b/docs/organizations/managing-security-and-risk.md index d78d910679..0b340681a2 100644 --- a/docs/organizations/managing-security-and-risk.md +++ b/docs/organizations/managing-security-and-risk.md @@ -122,6 +122,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** filter will not 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" From dea9c0ee8092f539d2a826d989eacbb04a64434c Mon Sep 17 00:00:00 2001 From: Raquel <25031075+RaquelHipolito@users.noreply.github.com> Date: Fri, 4 Oct 2024 15:02:56 +0100 Subject: [PATCH 07/45] adding segments page --- docs/organizations/segments | 2 -- docs/organizations/segments.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 2 deletions(-) delete mode 100644 docs/organizations/segments create mode 100644 docs/organizations/segments.md diff --git a/docs/organizations/segments b/docs/organizations/segments deleted file mode 100644 index 186f6a153d..0000000000 --- a/docs/organizations/segments +++ /dev/null @@ -1,2 +0,0 @@ -Collect all info about Segments to reduce repetition and distraction - later we'll add more providers as well and need to comunicate intructions. - diff --git a/docs/organizations/segments.md b/docs/organizations/segments.md new file mode 100644 index 0000000000..d7542cb642 --- /dev/null +++ b/docs/organizations/segments.md @@ -0,0 +1,30 @@ +Collect all info about Segments to reduce repetition and distraction - later we'll add more providers as well and need to comunicate intructions. + +# Segments + +Segmets are... + +### Ho can segments be utilised? +- [Grade](../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade) +- Repo list > link +- SRM > link + +!!! note + To enable **Segments**, an initial sync between GitHub and Codacy needs to happen, which ensures that the repository custom properties from GitHub are reflected in Codacy. Once completed, you can use your custom properties as a **Segments** filter to better locate and organize repositories within Codacy. + + 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). + +!!! 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. + + +
+
From 6834254364408aa86544f4e679b23767f5a38281 Mon Sep 17 00:00:00 2001 From: Raquel <25031075+RaquelHipolito@users.noreply.github.com> Date: Fri, 4 Oct 2024 15:28:12 +0100 Subject: [PATCH 09/45] titles sizes --- docs/organizations/segments.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/organizations/segments.md b/docs/organizations/segments.md index 2a45de15ed..15d2b9e34e 100644 --- a/docs/organizations/segments.md +++ b/docs/organizations/segments.md @@ -12,17 +12,17 @@ Segmets are dimentions that Codacy reads from your provider that organizes repos ##### 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. -###### Enable Segments +#### Enable Segments To enable **Segments**, an initial sync between GitHub and Codacy needs to happen, which ensures that the repository custom properties from GitHub are reflected in Codacy. Once completed, you can use your custom properties as a **Segments** filter to better locate and organize repositories within Codacy. -###### Keep Segments in sync +#### 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). Accepting this permission enables automatic synchronization of any future changes to the custom properties in GitHub. !!! 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. -> ** How to setup Custom Properties in GitHub ** +> ##### How to setup Custom Properties in GitHub > 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). *** From 85bc7c0e0532cc23e8e7810550c35d67458d1529 Mon Sep 17 00:00:00 2001 From: Raquel <25031075+RaquelHipolito@users.noreply.github.com> Date: Fri, 4 Oct 2024 15:42:58 +0100 Subject: [PATCH 10/45] Update segments.md --- docs/organizations/segments.md | 34 ++++++++++++++++++---------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/docs/organizations/segments.md b/docs/organizations/segments.md index 15d2b9e34e..41de8b4f44 100644 --- a/docs/organizations/segments.md +++ b/docs/organizations/segments.md @@ -1,29 +1,31 @@ -Collect all info about Segments to reduce repetition and distraction - later we'll add more providers as well and need to comunicate intructions. - # Segments -Segmets are dimentions that Codacy reads from your provider that organizes repositories into relevant groups for you. +Segments are dimentions that Codacy reads from your provider that organizes repositories into relevant groups for you. Today segments in codacy is available for: +- [GitHub Custom Properties](../#github-custom-properties) +

### How can segments be utilised? - [Repositoy list](../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade) -- [Security & Management Risk](../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade) - - -### GitHub -##### 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. - -#### Enable Segments -To enable **Segments**, an initial sync between GitHub and Codacy needs to happen, which ensures that the repository custom properties from GitHub are reflected in Codacy. Once completed, you can use your custom properties as a **Segments** filter to better locate and organize repositories within Codacy. - +- [Security & Management Risk](../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade) +

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

#### 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). Accepting this permission enables automatic synchronization of any future changes to the custom properties in GitHub. +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. !!! 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. +



-> ##### How to setup Custom Properties in GitHub -> 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). + + + +### 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. + +> ###### How to setup _Custom Properties_ in GitHub +> ###### 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). *** From f81d0db68ca4479cccf800ed97bef4a927f0ad75 Mon Sep 17 00:00:00 2001 From: Raquel <25031075+RaquelHipolito@users.noreply.github.com> Date: Fri, 4 Oct 2024 15:43:26 +0100 Subject: [PATCH 11/45] Update segments.md --- docs/organizations/segments.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/organizations/segments.md b/docs/organizations/segments.md index 41de8b4f44..c699d162af 100644 --- a/docs/organizations/segments.md +++ b/docs/organizations/segments.md @@ -26,9 +26,9 @@ Create, use, and manage custom properties for your repositories directly in GitH > ###### How to setup _Custom Properties_ in GitHub > ###### 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). - +

*** - +



#### Chekc out what's new and to come in Codacy
From 4ead91c2b37c078b19ffe1f673e66f94ada278ca Mon Sep 17 00:00:00 2001 From: RaquelHipolito Date: Thu, 10 Oct 2024 17:25:34 +0100 Subject: [PATCH 42/45] testing page bracking --- docs/organizations/segments.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/organizations/segments.md b/docs/organizations/segments.md index 5938edee69..689c0d9239 100644 --- a/docs/organizations/segments.md +++ b/docs/organizations/segments.md @@ -10,7 +10,7 @@ Segments are dimensions that Codacy reads from your provider that organizes repo 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"} @@ -24,7 +24,7 @@ For changes to repository **Custom Properties** in GitHub to be **automatically* 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
From e2f2cd44b61bcfa54a959b69d97516c0c928d79e Mon Sep 17 00:00:00 2001 From: RaquelHipolito Date: Thu, 10 Oct 2024 17:29:30 +0100 Subject: [PATCH 43/45] testing page breaking II --- docs/organizations/segments.md | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/docs/organizations/segments.md b/docs/organizations/segments.md index 689c0d9239..59d3acfcd6 100644 --- a/docs/organizations/segments.md +++ b/docs/organizations/segments.md @@ -10,7 +10,7 @@ Segments are dimensions that Codacy reads from your provider that organizes repo 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"} @@ -22,16 +22,3 @@ Create, use, and manage custom properties for your repositories directly in GitH 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