Skip to content
This documentation is a preview of the pull request #2301

For the latest updates and improvements in production, open docs.codacy.com instead.

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 - Bitbucket Projects

Where can Segments be utilised?#

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 Segments after sync

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

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.

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.

Refer to Bitbucket's official documentation for detailed steps on how to add, edit, and manage Projects.

Keep Segments in sync#

After the first sync is done, Bitbucket Projects will continue to be insync with Codacy automatically.



Check out what's new, and to come, in Codacy#

Share your feedback 📢

Did this page help you?

Thanks for the feedback! Is there anything else you'd like to tell us about this page?

We're sorry to hear that. Please let us know what we can improve:

Alternatively, you can create a more detailed issue on our GitHub repository.

Thanks for helping improve the Codacy documentation.

Edit this page on GitHub if you notice something wrong or missing.

If you have a question or need help please contact support@codacy.com.

Last modified October 30, 2024