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

532 publish proto files #676

Closed

Conversation

amberzsy
Copy link
Contributor

@amberzsy amberzsy commented Nov 15, 2024

Description

publish example protobufs generated with semi-automation tooling

TODO:

  1. add support for compile protos. (make sure no syntax error etc)
  2. generate protobuf language clients in spec repo.

after second thought on proposal, submodule not optimal ideas.
probably, we should do

  1. Raw proto (which generated from Spec with certain tooling) defined in /protobuf. it should be machine generated files. But for now, i have it as handwritten ones to unblock grpc poc effort.
  2. protobuf compile should compile the raw proto into *.proto (or some jars) in the release.
  3. similar to opensearch-java which download https://github.com/opensearch-project/opensearch-java/blob/c7103d87423e44aa5ef57bb940496a6e3b74ff78/java-codegen/build.gradle.kts#L75 the output yaml file from release, the Core and OpenSearch-Java or other language client can download/pull from spec repo.

cc: @karenyrx @dblock for review and better idea.

Issues Resolved

#532

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@amberzsy amberzsy force-pushed the 532_publish_proto_files branch from 88fb8db to fbc26bd Compare November 15, 2024 09:26
Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
517 349 (67.5 %)

Copy link
Contributor

github-actions bot commented Nov 15, 2024

Changes Analysis

Commit SHA: ad83bfe
Comparing To SHA: 07e329e

API Changes

Summary

NO CHANGES

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/11889503341/artifacts/2200450788

API Coverage

Before After Δ
Covered (%) 588 (57.59 %) 588 (57.59 %) 0 (0 %)
Uncovered (%) 433 (42.41 %) 433 (42.41 %) 0 (0 %)
Unknown 35 35 0

@amberzsy amberzsy force-pushed the 532_publish_proto_files branch from 3be6fb4 to e0b2236 Compare November 18, 2024 09:27
Signed-off-by: amberzsy <[email protected]>
@amberzsy amberzsy marked this pull request as ready for review November 18, 2024 09:44
@dblock
Copy link
Member

dblock commented Nov 18, 2024

Were these authored by hand or a result of a tool?

I'd like to merge a little bit more than this, some kind of useful MVP, that for example contains these files and just enough README information of what they are, maybe some CI.

@amberzsy
Copy link
Contributor Author

Were these authored by hand or a result of a tool?

for now, it's authored by hand. but eventually it would be machine generated code from spec.

I'd like to merge a little bit more than this, some kind of useful MVP, that for example contains these files and just enough README information of what they are, maybe some CI.

yes, make sense.

@amberzsy
Copy link
Contributor Author

amberzsy commented Mar 3, 2025

close the PR as it's for PoC purpose.
next step:

  1. create new opensearch-protobuf repo and for both handroll (short-term) and machine-generated proto would be published in separate repo.
  2. the pre/post-processing and generator API tool trigger would all be in opensearch-protobuf repo. as well as generated code and compilation would move to new repo.
  3. the remaining effort in current Spec repo is to have GHA which triggered by spec PR, then can trigger/call opensearch-protobuf GHA.

@amberzsy amberzsy closed this Mar 3, 2025
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