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

Generate gRPC API using buf #261

Merged
merged 3 commits into from
May 27, 2022
Merged

Generate gRPC API using buf #261

merged 3 commits into from
May 27, 2022

Conversation

sevein
Copy link
Member

@sevein sevein commented May 26, 2022

This pull request adds new timestamp fields to Job and Task:

message Job {
	// ...
	google.protobuf.Timestamp start_time = 6;
}

message Task {
	// ...
	google.protobuf.Timestamp start_time = 9;
	google.protobuf.Timestamp end_time = 10;
}
  • The API is now described under /proto and the generated can be found at /a3m/api.
  • API documents are now managed with buf.build and published to the BSR
  • API clients can rely on remote code generation to install generated code using standard packages
  • buf can be invoked via make buf ARG=help

Peek 2022-05-27 09-46

Connects to #80.

@sevein sevein force-pushed the dev/buf-api branch 4 times, most recently from dd4f57e to 6fd5446 Compare May 26, 2022 17:04
sevein added 2 commits May 27, 2022 08:32
It includes a compatibility fix with recent pip releases.
@sevein sevein force-pushed the dev/buf-api branch 2 times, most recently from b704036 to d8e07b4 Compare May 27, 2022 07:51
.github/workflows/buf-pull-request.yml Outdated Show resolved Hide resolved
.github/workflows/buf-push.yml Show resolved Hide resolved
Makefile Show resolved Hide resolved
a3m/server/rpc/client.py Outdated Show resolved Hide resolved
setup.cfg Show resolved Hide resolved
Copy link
Member

@sbreker sbreker left a comment

Choose a reason for hiding this comment

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

Looks great 👍

* APIs are described in `/proto` using buf.build.
* Generated code is stored under `a3m/api`.
* Genearted docs can be found at https://buf.build/artefactual/a3m.
* It includes a couple of CI workflows to validate PRs and push to the BSR.
@sevein sevein merged commit 3056896 into main May 27, 2022
@sevein sevein deleted the dev/buf-api branch May 27, 2022 16:50
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