Skip to content

Commit

Permalink
Add documentation for custom propery filter PLUTO-1026 (#2194)
Browse files Browse the repository at this point in the history
* Add documentation for custom propery filter

Add documentation to the managing repositories section to reflect
the new repository custom property filter for github.

When these filters exist in other areas we might want to consider
moving part of this documentation to it's own area.

* Add correct images to docs

* Update section anchor to be linkable from app

* Link to Github RCP managemenent page
  • Loading branch information
jorgebraz authored Sep 17, 2024
1 parent 601826f commit f1e3f8e
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions docs/organizations/managing-repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,28 @@ To follow or unfollow repositories on Codacy:

Conversely, you automatically **stop following** a repository as soon as you try accessing any page from that repository but you don't have permissions to see that repository anymore.

## Repository Custom Properties Filter {: id="custom-properties-filter"}

Codacy allows you to filter repositories based on **Repository Custom Properties** from GitHub. This feature helps you to categorize and filter repositories more effectively within the Codacy platform.

![Repositories list filter](images/organization-manage-repos-custom-properties.png)

To enable this feature, users must go through an **initial sync** between GitHub and Codacy, which ensures that the repository custom properties from GitHub are reflected in Codacy.

![Repositories list sync](images/organization-manage-repos-custom-properties-sync.png)

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

Once the sync is completed, you can use these custom properties as a filter to better locate and organize repositories within Codacy.

!!! note
To fully take advantage of this feature, you can 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.

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

## See also

- [Which metrics does Codacy calculate?](../faq/code-analysis/which-metrics-does-codacy-calculate.md)

0 comments on commit f1e3f8e

Please sign in to comment.