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

chore: centralize proto files #88

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft

chore: centralize proto files #88

wants to merge 13 commits into from

Conversation

whynowy
Copy link
Member

@whynowy whynowy commented Dec 1, 2023

.
Signed-off-by: Derek Wang <[email protected]>
.
Signed-off-by: Derek Wang <[email protected]>
.
Signed-off-by: Derek Wang <[email protected]>
@vigith
Copy link
Member

vigith commented Dec 1, 2023

Should we completely delete the proto file from here or just indicate in the CI process that it has diverged? Otherwise developing new changes might get tricker as it pulls from the main branch of numaflow.

@whynowy
Copy link
Member Author

whynowy commented Dec 2, 2023

Should we completely delete the proto file from here or just indicate in the CI process that it has diverged? Otherwise developing new changes might get tricker as it pulls from the main branch of numaflow.

Good question.

I believe this would be the right process for any other sdks other than golang - however golang will always be the 1st one if there's any change to the protocols, we need to think about how to make it smooth for golang.

@whynowy
Copy link
Member Author

whynowy commented Dec 4, 2023

I imagine the process of introducing proto file changes would be:

  1. A PR in numaflow repo for proto file changes.
  2. During Go sdk development, temporarily points to the numaflow PR branch to download proto files for codegen, and raise a PR;
  3. Merge numaflow PR;
  4. Merge Go sdk PR.
  5. Work on other SDKs implementation.
  6. Add a non-blocking CI to run make proto for all the sdks, to indicate if there's drift on the codegen.

Another option is, use Go SDK repo as the the location for centralized proto files.

@vigith - WDYT?

@vigith
Copy link
Member

vigith commented Dec 4, 2023

I imagine the process of introducing proto file changes would be:

  1. A PR in numaflow repo for proto file changes.
  2. During Go sdk development, temporarily points to the numaflow PR branch to download proto files for codegen, and raise a PR;
  3. Merge numaflow PR;
  4. Merge Go sdk PR.
  5. Work on other SDKs implementation.
  6. Add a non-blocking CI to run make proto for all the sdks, to indicate if there's drift on the codegen.

Sounds good to me.

I think we can make the main in this URL path can be overrideable via ENV var? This will help in fetching the proto file easier for development without editing the script.

@whynowy
Copy link
Member Author

whynowy commented Dec 5, 2023

I imagine the process of introducing proto file changes would be:

  1. A PR in numaflow repo for proto file changes.
  2. During Go sdk development, temporarily points to the numaflow PR branch to download proto files for codegen, and raise a PR;
  3. Merge numaflow PR;
  4. Merge Go sdk PR.
  5. Work on other SDKs implementation.
  6. Add a non-blocking CI to run make proto for all the sdks, to indicate if there's drift on the codegen.

Sounds good to me.

I think we can make the main in this URL path can be overrideable via ENV var? This will help in fetching the proto file easier for development without editing the script.

Makes sense.

.
Signed-off-by: Derek Wang <[email protected]>
.
Signed-off-by: Derek Wang <[email protected]>
.
Signed-off-by: Derek Wang <[email protected]>
.
Signed-off-by: Derek Wang <[email protected]>
.
Signed-off-by: Derek Wang <[email protected]>
.
Signed-off-by: Derek Wang <[email protected]>
Copy link
Contributor

@yhl25 yhl25 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we please hold off on merging this pull request for now? I am currently making some changes to the proto files in two of my pending PRs. Merging this right now could create conflicts with those changes.

@whynowy whynowy marked this pull request as draft January 17, 2024 20:05
@whynowy
Copy link
Member Author

whynowy commented Jan 18, 2024

Could we please hold off on merging this pull request for now? I am currently making some changes to the proto files in two of my pending PRs. Merging this right now could create conflicts with those changes.

@yhl25 - can you remove the change request?

@whynowy
Copy link
Member Author

whynowy commented Jan 18, 2024

Proto Generate will be green after numaproj/numaflow#1466 is merged.

Signed-off-by: Derek Wang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants