Skip to content

doc: Update the Segments setup instructions for Github #2641

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.

Sign up for GitHub

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

Merged
nfcodacy merged 2 commits into from
Apr 21, 2026
Merged

doc: Update the Segments setup instructions for Github #2641

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5e0458
doc: Update the Segments setup instructions for Github
nfcodacy Apr 20, 2026
0a23dab
clean: Fix some nitpicks
nfcodacy Apr 20, 2026
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
11 changes: 8 additions & 3 deletions docs/organizations/segments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Check failure on line 4 in docs/organizations/segments.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'orgs'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'orgs'?", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 4, "column": 110}}}, "severity": "ERROR"}

Check failure on line 4 in docs/organizations/segments.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'aren't' instead of 'are not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'aren't' instead of 'are not'.", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 4, "column": 72}}}, "severity": "ERROR"}

Check failure on line 4 in docs/organizations/segments.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'orgs'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'orgs'?", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 4, "column": 45}}}, "severity": "ERROR"}

Check failure on line 4 in docs/organizations/segments.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'aren't' instead of 'are not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'aren't' instead of 'are not'.", "location": {"path": "docs/organizations/segments.md", "range": {"start": {"line": 4, "column": 14}}}, "severity": "ERROR"}

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)

Expand All @@ -21,13 +23,16 @@
### 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.

Expand Down
Loading