package builder

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Store (stream Chunk, StoreResponse)

  builder.proto:53

  Store persists a file on the builder. Simple implementations might write the file to a directory and clean up files older than a day every hour in a background (e.g. cron) job. Cluster implementations might write the file to a shared network directory (most pragmatic/common), introduce an custom disk abstraction layer (most elegant?) or stickily load-balance via a proxy job (only listed for completeness as it limits build throughput). Cloud implementations might write the file to a key/value store with a TTL of one day. Files are transferred as a stream of chunks with size 4096 bytes.

  message StoreResponse

  builder.proto:17

  TODO: return new path for this file. This makes it easy to implement Store on top of a Content-Addressible Storage (CAS) system.

  (message has no fields)

• rpc Build (BuildRequest, stream BuildProgress)

  builder.proto:60

  Build ensures the specified input_path are available in the current working directory, changes into working_directory, then runs a distri build with any additional build_flag specified. Build output artifacts paths are streamed in BuildProgress messages.

  message BuildRequest

  builder.proto:26

  • string working_directory = 1

    relative

  • repeated string input_path = 2

    relative

  • repeated string build_flag = 3

  message BuildProgress

  builder.proto:32

  • repeated string output_path = 1

    Build artifact paths (possibly empty, e.g. in keepalive progress updates), e.g. build/emacs/emacs-amd64-26.2.squashfs.

    relative

• rpc Retrieve (RetrieveRequest, stream Chunk)

  builder.proto:63

  Retrieve streams the file located at path in chunks of size 4096 bytes.

  message RetrieveRequest

  builder.proto:22

  • string path = 1

    relative, typically output_path from BuildProgress

Used as request type in: Build.Store

Used as response type in: Build.Retrieve

• string path = 1

  path is discarded in all but the first Store Chunk message per stream. path is unset in all but the first Retrieve Chunk message per stream.

  relative, e.g. pkgs/emacs/build.textproto.

• bytes chunk = 2