From e5e045876cbcc2d64959582766e0188815d3e22e Mon Sep 17 00:00:00 2001 From: Nuno Fernandes Date: Mon, 20 Apr 2026 16:36:41 +0100 Subject: [PATCH 1/2] doc: Update the Segments setup instructions for Github --- docs/organizations/segments.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/organizations/segments.md b/docs/organizations/segments.md index 2d3046794a..53b8a0f392 100644 --- a/docs/organizations/segments.md +++ b/docs/organizations/segments.md @@ -1,8 +1,10 @@ # Segments -_Segments are not supported for Personal orgs, as Custom Properties are not available in Github for these orgs._ +!!! important + Segments are not supported for Personal orgs, as Custom Properties are not available in Github for these orgs. + +Segments are dimensions that Codacy reads from your provider that organizes repositories into relevant groups for you. Today, Segments are available for: -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) - [Bitbucket Projects](#bitbucket-projects) @@ -21,13 +23,16 @@ To enable Segments, an initial sync between your provider and Codacy needs to ha ### GitHub Custom Properties {: id="github-custom-properties"} Custom properties allow you to assign tags or metadata to repositories, making it easier to categorize and filter them. Create, use, and manage custom properties for your repositories directly 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) for detailed steps on how to add, edit, and manage repository **Custom Properties**. +> 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 insync 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. +Also, the target Custom Properties need to have the option **Allow repository actors to set this property** enabled in Github. + ### Bitbucket Projects {: id="bitbucket-projects"} Bitbucket Projects allow you to organize your repositories into relevant contexts for you, making it easier to categorize and filter them. Create, use, and manage Projects for your repositories directly in Bitbucket. From 0a23dabfeeb3145bff83e8e3fe83a640b763ff35 Mon Sep 17 00:00:00 2001 From: Nuno Fernandes Date: Mon, 20 Apr 2026 16:49:28 +0100 Subject: [PATCH 2/2] clean: Fix some nitpicks --- 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 53b8a0f392..3690670183 100644 --- a/docs/organizations/segments.md +++ b/docs/organizations/segments.md @@ -1,7 +1,7 @@ # Segments !!! important - Segments are not supported for Personal orgs, as Custom Properties are not available in Github for these orgs. + Segments are not supported for Personal orgs, as Custom Properties are not available in GitHub for these orgs. Segments are dimensions that Codacy reads from your provider that organizes repositories into relevant groups for you. Today, Segments are available for: @@ -31,7 +31,7 @@ For changes to repository **Custom Properties** in GitHub to be **automatically* !!! 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. -Also, the target Custom Properties need to have the option **Allow repository actors to set this property** enabled in Github. +Also, the target Custom Properties need to have the option **Allow repository actors to set this property** enabled in GitHub. ### Bitbucket Projects {: id="bitbucket-projects"} Bitbucket Projects allow you to organize your repositories into relevant contexts for you, making it easier to categorize and filter them. Create, use, and manage Projects for your repositories directly in Bitbucket.