search

opiproject / opi-api

Open Programmable Infrastructure API and Behavioral Model
Apache License 2.0
31 stars 40 forks source link

add or remove auto-gen files #142

Open glimchb opened 1 year ago

glimchb commented 1 year ago

see #139 vs #141

PWAlessi commented 1 year ago

FYI, Google just provides the .proto files for their APIs (see https://github.com/googleapis/googleapis/tree/master/google). Directory structure typically ./service/v1/*.proto (ex. google ai platform https://github.com/googleapis/googleapis/tree/master/google/cloud/aiplatform/v1)

Should we move to this structure? I believe that we only want to provide the .proto files as they are the interface definitions.

jainvipin commented 1 year ago

auto-gen files create a nuisance when merging, but helps avoid additional code generation by the users of the APIs.

I would prefer keeping generated files and language bindings/packages so they can act as reference and also avoid burden on the users of the APIs (which would be inherently in a specific language). Of course developers have to deal with merge conflicts resolution on generated files, which can be handled easily (although unwanted)

glimchb commented 1 year ago

what we landing on now is separate repo for only generated files....

every time PR for proto is submitted, CI/CD github action will auto-create and commit generated files and even maybe bump a version

jainvipin commented 1 year ago

makes sense. thanks! good idea.