Description
Prerequisites:
- Is the functionality available in the GitHub UI? If so, please provide a link to information about the feature.
Organization owners can define custom properties in organization settings:
https://github.com/organizations/ORGANIZATION/settings/custom-properties
Custom properties can be added to individual repositories in their settings page:
https://github.com/ORGANIZATION/REPOSITORY/settings/custom-properties
Custom properties can also be edited in bulk in organization's settings:
https://github.com/organizations/ORGANIZATION/settings/custom-properties?tab=set-values
Custom Properties can be used as search filters and to categorize repositories for custom automations etc.
- Is the functionality available through the GitHub API? If the functionality is available, please provide links to the
API documentation (https://developer.github.com/v3/) as well as the Octokit documentation (https://octokit.github.io/).
https://docs.github.com/en/rest/repos/custom-properties?apiVersion=2022-11-28
New Feature
Add new custom_properties section to .github/settings.yml:
repository:
...
custom_properties:
my_custom_property: some_value
my_other_custom_property: some_other_value
... App should sync repository's custom properties, removing those that are set in repository but not in settings.yml, adding those that are not yet set in repository & modifying the rest as needed.
Adding totally new custom properties to organization is naturally out of scope of this feature but obviously app should handle case where non-existent custom property is added to settings.yml gracefully.