Welcome to the Build API.
Make sure you've consulted the Build and CI teams when considering making breaking changes that affect the Build API.
This directory is a separate repo that contains all of the raw .proto files. You will find message, service, and method definitions, and their configurations. You will need to commit and upload the proto changes separately from the chromite changes.
When making changes to the proto, you must:
At time of writing, the PCQ does not support
Cq-Depend: between the infra/proto and chromite repos, so it must be handled manually.
This repo was and will be pinned to a specific revision in the manifest files when we get closer to completing work on the Build API. For the speed we're moving at now, though, having that revision pinned and updating the manifest has caused far more problems than its solving.
When we do go back to the pinned revision:
The generated protobuf messages.
Do not edit files in this package directly!
The proto can be compiled using the
compile_build_api_proto script in the api directory. The protoc version is locked and fetched from CIPD to ensure compatibility with the client library in
This directory contains the entry point for all of the implemented services. The protobuf service module option (defined in build_api.proto) references the module in this package. The functions in this package should all operate as one would expect a controller to operate in an MVC application - translating the request into the internal representation that's passed along to the relevant service(s), then translates their output to a specified response format.
This directory contains scripts that may not be 100% supported yet. See
contrib/README.md for information about the scripts.