From aa8edee50bd919814b1a7059056000482d8f8538 Mon Sep 17 00:00:00 2001 From: Livio Spring Date: Mon, 7 Jul 2025 03:28:38 -0400 Subject: [PATCH] chore(docs): prevent readme overwrite (#10170) # Which Problems Are Solved To generate the docs, we rely on a protoc plugin to generate an openAPI definition from connectRPC / proto. Since the plugin is not available on buf.build, we currently download the released version. As the tar contains a licence and a readme, this overwrote existing internal files. # How the Problems Are Solved Download and extract the plugin in a separate folder and update buf.gen.yaml accordingly. # Additional Changes None # Additional Context relates to #9483 --- docs/buf.gen.yaml | 2 +- docs/plugin-download.sh | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/buf.gen.yaml b/docs/buf.gen.yaml index b507a2fb9c..d23040f416 100644 --- a/docs/buf.gen.yaml +++ b/docs/buf.gen.yaml @@ -9,7 +9,7 @@ plugins: - allow_delete_body - remove_internal_comments=true - preserve_rpc_order=true - - local: ./protoc-gen-connect-openapi + - local: ./protoc-gen-connect-openapi/protoc-gen-connect-openapi out: .artifacts/openapi3 strategy: all opt: diff --git a/docs/plugin-download.sh b/docs/plugin-download.sh index c6de8d702f..499326a1e7 100644 --- a/docs/plugin-download.sh +++ b/docs/plugin-download.sh @@ -1,5 +1,6 @@ echo $(uname -m) - +mkdir protoc-gen-connect-openapi +cd ./protoc-gen-connect-openapi/ if [ "$(uname)" = "Darwin" ]; then curl -L -o protoc-gen-connect-openapi.tar.gz https://github.com/sudorandom/protoc-gen-connect-openapi/releases/download/v0.18.0/protoc-gen-connect-openapi_0.18.0_darwin_all.tar.gz else