From 868c3a2bfbd704da40b1317707c68cafc8821aab Mon Sep 17 00:00:00 2001 From: Justin Santa Barbara Date: Wed, 19 Jul 2017 22:15:24 -0400 Subject: [PATCH] Add gen-api-docs target to makefile --- Makefile | 14 ++++++++++++++ docs/apireference/README.md | 6 +++--- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index ea7fab332c..3dc43f4dbd 100644 --- a/Makefile +++ b/Makefile @@ -252,6 +252,20 @@ gen-cli-docs: kops # Regenerate CLI docs KOPS_FEATURE_FLAGS= \ ${KOPS} genhelpdocs --out docs/cli +.PHONY: gen-api-docs +gen-api-docs: + # Follow procedure in docs/apireference/README.md + # Install the apiserver-builder commands + go get -u github.com/kubernetes-incubator/apiserver-builder/cmd/... + # Install the reference docs commands (apiserver-builder commands invoke these) + go get -u github.com/kubernetes-incubator/reference-docs/gen-apidocs/... + # Install the code generation commands (apiserver-builder commands invoke these) + go install k8s.io/kubernetes/cmd/libs/go2idl/openapi-gen + # Update the `pkg/openapi/openapi_generated.go` + ${GOPATH}/bin/apiserver-boot build generated --generator openapi --copyright hack/boilerplate/boilerplate.go.txt + go install k8s.io/kops/cmd/kops-server + ${GOPATH}/bin/apiserver-boot build docs --disable-delegated-auth=false --output-dir docs/apireference --server kops-server + .PHONY: push # Will always push a linux-based build up to the server push: crossbuild-nodeup diff --git a/docs/apireference/README.md b/docs/apireference/README.md index 921a75d986..76ebdcf0d4 100644 --- a/docs/apireference/README.md +++ b/docs/apireference/README.md @@ -8,10 +8,10 @@ Or build the most recent from src using: ```sh # Install the apiserver-builder commands -go get github.com/kubernetes-incubator/apiserver-builder/cmd/... +go get -u github.com/kubernetes-incubator/apiserver-builder/cmd/... -# Install the referene docs commands (apiserver-builder commands invoke these) -go get github.com/kubernetes-incubator/reference-docs/gen-apidocs/... +# Install the reference docs commands (apiserver-builder commands invoke these) +go get -u github.com/kubernetes-incubator/reference-docs/gen-apidocs/... # Install the code generation commands (apiserver-builder commands invoke these) go install k8s.io/kubernetes/cmd/libs/go2idl/openapi-gen