about summary refs log tree commit diff
path: root/tvix/build-go/README.md
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2023-12-09T14·28+0200
committerclbot <clbot@tvl.fyi>2023-12-11T21·43+0000
commita1b2dc8aaf87b73025f4090308c9649e8bf66a99 (patch)
treec97cbc4bda657a98b99348b1d3b02f7026b1a821 /tvix/build-go/README.md
parentfd27d8ddc3a27fd89a3a132343c6a1ad8da3671c (diff)
feat(tvix/build-go): init r/7152
This adds the generated golang bindings for tvix-build.

Change-Id: I2eb0d1cc38bc2fa34afd7c904eea05c5ee192cce
Reviewed-on: https://cl.tvl.fyi/c/depot/+/10242
Tested-by: BuildkiteCI
Autosubmit: flokli <flokli@flokli.de>
Reviewed-by: raitobezarius <tvl@lahfa.xyz>
Diffstat (limited to 'tvix/build-go/README.md')
-rw-r--r--tvix/build-go/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/tvix/build-go/README.md b/tvix/build-go/README.md
new file mode 100644
index 000000000000..19edfced01a0
--- /dev/null
+++ b/tvix/build-go/README.md
@@ -0,0 +1,10 @@
+# build-go
+
+This directory contains generated golang bindings, both for the `tvix-build`
+data models, as well as the gRPC bindings.
+
+They are generated with `mg run //tvix/build-go:regenerate`.
+These files end with `.pb.go`, and are ensured to be up to date by a CI check.
+
+Additionally, code useful when interacting with these data structures
+(ending just with `.go`) is provided.