TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-08-11 21:27:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): prevent readme overwrite (#10170)

Browse Source 
# 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
This commit is contained in:
Livio Spring
2025-07-07 03:28:38 -04:00
committed by GitHub
parent 27cd1d8518
commit aa8edee50b
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/buf.gen.yaml
View File

@@ -9,7 +9,7 @@ plugins:
- allow_delete_body - allow_delete_body
- remove_internal_comments=true - remove_internal_comments=true
- preserve_rpc_order=true - preserve_rpc_order=true
- local: ./protoc-gen-connect-openapi - local: ./protoc-gen-connect-openapi/protoc-gen-connect-openapi
out: .artifacts/openapi3 out: .artifacts/openapi3
strategy: all strategy: all
opt: opt:

3
docs/plugin-download.sh
View File

@@ -1,5 +1,6 @@
echo $(uname -m) echo $(uname -m)
mkdir protoc-gen-connect-openapi
cd ./protoc-gen-connect-openapi/
if [ "$(uname)" = "Darwin" ]; then 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 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 else