Support Github "Custom Properties" in Server Config

[chrisguitarguy]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request. Searching for pre-existing feature requests helps us consolidate datapoints for identical requirements into a single place, thank you!
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
• If you are interested in working on this issue or have submitted a pull request, please leave a comment.

---

• I'd be willing to implement this feature (contributing guide)

Describe the user story

Githug orgs have this feature called Custom Properties https://docs.github.com/en/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization

It would be neat to be able to use these the same way one can use them in repo rulesets on github to allowlist which repos can run atlantis.

Basically giving control of "what can atlantis run" to the github UI/API vs an atlantis common or config file on the server. Would make it slightly easier for orgs using github to add new repos to an allowed list without needing to update server config -- it would let us move faster with terraform automation at least.

Describe the solution you'd like

I'd love to be able to use these as part of the repo allow-list in atlantis' server side config, basically being able to do something like this:

repos:
  - id: *
    github_propertis:
      some_property: true

or maybe via a --gh-custom-properties flag or something similar to the gh flags described here: https://www.runatlantis.io/docs/server-configuration.html

These custom properties are already included in webhooks as part of the repository object under custom_properties:

{
  "...": "...",
  "repository": {
      "custom_properties": {
          "property_name": "property_value",
          "allow_atlantis": true
      }
   }
}

More than happy to work on this, but might need some help to be pointed in the right direction.

Describe the drawbacks of your solution

The repo config file solution would mean having vendor specific extensions, which is probably not great.

The CLI config option seems a better bet as that already has some vendor specific things.

Describe alternatives you've considered

Simply updating the config file and re-deploying atlantis (on ECS with EFS in our case).