feat: Infrastructure for generating protobuf docs

docker/registry/protoc-base/gradle.properties

@@ -1,5 +1,5 @@
 io.deephaven.project.ProjectType=DOCKER_REGISTRY
 deephaven.registry.imageName=ghcr.io/deephaven/protoc-base:latest
-deephaven.registry.imageId=ghcr.io/deephaven/protoc-base@sha256:70f31806515b4d160ab6ddf9b7b6612441b5918b0f1c5586ee2cc9ad8a4c81da
+deephaven.registry.imageId=ghcr.io/deephaven/protoc-base@sha256:7b43037ce0cf2a82aff73605a689754620791238ed598b7ae41aa5b225a27ccf
 # TODO(deephaven-base-images#54): arm64 native image for cpp-client-base
 deephaven.registry.platform=linux/amd64

proto/proto-backplane-grpc/Dockerfile

@@ -11,6 +11,7 @@ RUN set -eux; \
  mkdir -p /generated/go; \
  mkdir -p /generated/python; \
  mkdir -p /generated/cpp; \
+ mkdir -p /generated/proto-doc; \
  /opt/protoc/bin/protoc \
  --plugin=protoc-gen-grpc=/opt/java/bin/protoc-gen-grpc-java \
  --java_out=/generated/java \
@@ -84,4 +85,71 @@ RUN set -eux; \
  /includes/deephaven/proto/partitionedtable.proto \
  /includes/deephaven/proto/config.proto \
  /includes/deephaven/proto/hierarchicaltable.proto \
- /includes/deephaven/proto/storage.proto;
+ /includes/deephaven/proto/storage.proto; \
+ # proto-doc-gen does not support writing multiple proto files to multiple docs, must break up command
+ /opt/protoc/bin/protoc \
+ --plugin=protoc-gen-doc=/usr/local/bin/protoc-gen-doc \
+ --doc_out=generated/proto-doc \
+ --doc_opt=markdown,ticket.md \
+ -I/includes \
+ /includes/deephaven/proto/ticket.proto; \
+ /opt/protoc/bin/protoc \
+ --plugin=protoc-gen-doc=/usr/local/bin/protoc-gen-doc \
+ --doc_out=generated/proto-doc \
+ --doc_opt=markdown,console.md \
+ -I/includes \
+ /includes/deephaven/proto/console.proto; \
+ /opt/protoc/bin/protoc \
+ --plugin=protoc-gen-doc=/usr/local/bin/protoc-gen-doc \
+ --doc_out=generated/proto-doc \
+ --doc_opt=markdown,object.md \
+ -I/includes \
+ /includes/deephaven/proto/object.proto; \
+ /opt/protoc/bin/protoc \
+ --plugin=protoc-gen-doc=/usr/local/bin/protoc-gen-doc \
+ --doc_out=generated/proto-doc \
+ --doc_opt=markdown,session.md \
+ -I/includes \
+ /includes/deephaven/proto/session.proto; \
+ /opt/protoc/bin/protoc \
+ --plugin=protoc-gen-doc=/usr/local/bin/protoc-gen-doc \
+ --doc_out=generated/proto-doc \
+ --doc_opt=markdown,table.md \
+ -I/includes \
+ /includes/deephaven/proto/table.proto; \
+ /opt/protoc/bin/protoc \
+ --plugin=protoc-gen-doc=/usr/local/bin/protoc-gen-doc \
+ --doc_out=generated/proto-doc \
+ --doc_opt=markdown,application.md \
+ -I/includes \
+ /includes/deephaven/proto/application.proto; \
+ /opt/protoc/bin/protoc \
+ --plugin=protoc-gen-doc=/usr/local/bin/protoc-gen-doc \
+ --doc_out=generated/proto-doc \
+ --doc_opt=markdown,inputtable.md \
+ -I/includes \
+ /includes/deephaven/proto/inputtable.proto; \
+ /opt/protoc/bin/protoc \
+ --plugin=protoc-gen-doc=/usr/local/bin/protoc-gen-doc \
+ --doc_out=generated/proto-doc \
+ --doc_opt=markdown,partitionedtable.md \
+ -I/includes \
+ /includes/deephaven/proto/partitionedtable.proto; \
+ /opt/protoc/bin/protoc \
+ --plugin=protoc-gen-doc=/usr/local/bin/protoc-gen-doc \
+ --doc_out=generated/proto-doc \
+ --doc_opt=markdown,config.md \
+ -I/includes \
+ /includes/deephaven/proto/config.proto; \
+ /opt/protoc/bin/protoc \
+ --plugin=protoc-gen-doc=/usr/local/bin/protoc-gen-doc \
+ --doc_out=generated/proto-doc \
+ --doc_opt=markdown,hierarchicaltable.md \
+ -I/includes \
+ /includes/deephaven/proto/hierarchicaltable.proto; \
+ /opt/protoc/bin/protoc \
+ --plugin=protoc-gen-doc=/usr/local/bin/protoc-gen-doc \
+ --doc_out=generated/proto-doc \
+ --doc_opt=markdown,storage.md \
+ -I/includes \
+ /includes/deephaven/proto/storage.proto; \

proto/proto-backplane-grpc/build.gradle

@@ -72,6 +72,29 @@ TaskProvider<Task> generateProtobuf = Docker.registerDockerTask(project, 'genera
  }
 }
 
+TaskProvider<Task> generateProtoDocs = Docker.registerDockerTask(project, 'generateProtoDocs') {
+ platform = 'linux/amd64'
+
+ copyIn {
+ from(layout.projectDirectory) {
+ include 'docs/'
+ include 'src/main/proto/'
+ }
+ }
+
+ dockerfile {
+ from('deephaven/protoc-base:local-build')
+ copyFile('docs/', '/docs')
+ copyFile('src/main/proto/', '/protos')
+ runCommand('mkdir /docs/out; ./docs/generate_docs.sh')
+ }
+
+ containerOutPath = '/docs/out'
+ copyOut {
+ into('docs/out')
+ }
+}
+
 // Provide js, go, python output as distinct artifacts - the java output will be consumed in this project by
 // declaring it as a new sourceset, see below. This could definitely be more precisely stated, but given that
 // all are generated in the same docker image creation step, we don't need to get too clever here.