Skip to content

Commit 1dac140

Browse files
authored
doc: Update the Segments setup instructions for Github (#2641)
* doc: Update the Segments setup instructions for Github * clean: Fix some nitpicks
1 parent 03f6bee commit 1dac140

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

docs/organizations/segments.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Segments
22

3-
_Segments are not supported for Personal orgs, as Custom Properties are not available in Github for these orgs._
3+
!!! important
4+
Segments are not supported for Personal orgs, as Custom Properties are not available in GitHub for these orgs.
5+
6+
Segments are dimensions that Codacy reads from your provider that organizes repositories into relevant groups for you. Today, Segments are available for:
47

5-
Segments are dimensions that Codacy reads from your provider that organizes repositories into relevant groups for you. Today, Segments is available for:
68
- [GitHub Custom Properties](#github-custom-properties)
79
- [Bitbucket Projects](#bitbucket-projects)
810

@@ -21,13 +23,16 @@ To enable Segments, an initial sync between your provider and Codacy needs to ha
2123
### GitHub Custom Properties {: id="github-custom-properties"}
2224
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.
2325

24-
> 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**.
26+
> 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**.
2527
2628
#### Keep Segments insync
2729
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).
30+
2831
!!! note
2932
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.
3033

34+
Also, the target Custom Properties need to have the option **Allow repository actors to set this property** enabled in GitHub.
35+
3136
### Bitbucket Projects {: id="bitbucket-projects"}
3237
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.
3338

0 commit comments

Comments
 (0)