Skip to content
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.

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

Custom properties support #1011

Open
mahe-work opened this issue Sep 2, 2024 · 1 comment
Open

Custom properties support #1011

mahe-work opened this issue Sep 2, 2024 · 1 comment

Comments

@mahe-work
Copy link

mahe-work commented Sep 2, 2024

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.

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.

@mahe-work
Copy link
Author

Our use case for this: Have repository templates for different organization units that among other things set repository settings and certain custom properties conforming to unit's dev practises when repository is created or template is merged to existing repository.

The aim is to minimize things to remember when creating new repositories and to enable further automations for groups of repositories identified by their custom properties.

This app would by our initial assessment work very well for our intended purposes but lacks the support for custom properties.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant