Skip to content

Commit cbd1126

Browse files
sandersmsartek-koltun
authored andcommitted
feat(buf): add badge for reporting buf ci operation
Signed-off-by: Mark Sanders <marksanders194@gmail.com>
1 parent 905308e commit cbd1126

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# OPI API and Behavioral Model Group
22

33
[![Linters](https://github.com/opiproject/opi-api/actions/workflows/linters.yml/badge.svg)](https://github.com/opiproject/opi-api/actions/workflows/linters.yml)
4+
[![Buf CI](https://github.com/opiproject/opi-api/actions/workflows/buf.yml/badge.svg)](https://github.com/opiproject/opi-api/actions/workflows/buf.yml)
45

56
## I Want To Contribute
67

@@ -55,6 +56,12 @@ The use of gRPC is the preferred mechanism for the config/control interface, wit
5556

5657
The OPI API boundary for the consumption interface will provide the exposed VF/PF capabilities to be used by the Host platform and/or the compute cores on the xPU.
5758

59+
## OPI API Checking and Publishing
60+
61+
The generation of the OPI API files from the protobuf definitions is handled by using the Buf tool for managing the schemas. The Buf tools provide for formatting, linting, building, and generation of code stubs. The Buf environment also provides a Buf Schema Registry (BSR) where the API can be published.
62+
63+
The OPI API is published to the BSR in the [opiproject](https://buf.build/opiproject/opi). This project contains the auto-generated documentation as well as the code and sdk files. Refer th the BSR for information and documentation.
64+
5865
---
5966

6067
- Leader

0 commit comments

Comments
 (0)