What are custom properties?
Custom properties are structured metadata fields that you can attach to repositories or organizations in your GitHub Enterprise Server instance. They allow you to decorate your repositories or organizations with information such as compliance frameworks, data sensitivity, or project details.
There are two types of custom properties:
- Repository custom properties: Metadata attached to individual repositories.
- Organization custom properties: Metadata attached to organizations within an enterprise.
What are the benefits of using custom properties?
As well as providing improved discovery, automated workflows, compliance tracking, targeted policy enforcement, and better reporting capabilities, custom properties enable powerful governance through ruleset integration.
Both repository and organization custom properties can be used as targeting criteria for rulesets, enabling fine-grained policy enforcement based on metadata.
- For repository custom rules, see Creating rulesets for repositories in your organization
How do I add and manage custom properties?
There are multiple ways to manage custom properties. To manage properties within GitHub, you can use:
- Your organization or enterprise settings. See Managing custom properties for repositories in your organization and Managing custom properties for organizations.
- GitHub's REST API endpoints for custom properties.