Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ GATEAY_API_VERSION ?= v1.2.0
DASHBOARD_VERSION ?= dev
TEST_TIMEOUT ?= 45m

# CRD Reference Documentation
CRD_REF_DOCS_VERSION ?= v0.1.0
CRD_REF_DOCS ?= $(LOCALBIN)/crd-ref-docs
CRD_DOCS_CONFIG ?= docs/crd/config.yaml
CRD_DOCS_OUTPUT ?= docs/crd/api.md

export KUBECONFIG = /tmp/$(KIND_NAME).kubeconfig

# go
Expand All @@ -29,7 +35,6 @@ GOBIN=$(shell go env GOPATH)/bin
else
GOBIN=$(shell go env GOBIN)
endif

GOOS ?= linux
GOARCH ?= amd64

Expand Down Expand Up @@ -346,3 +351,29 @@ helm-build-crds:
sort-import:
@./scripts/goimports-reviser.sh >/dev/null 2>&1
.PHONY: sort-import

.PHONY: generate-crd-docs
generate-crd-docs: manifests ## Generate CRD reference documentation in a single file
@mkdir -p $(dir $(CRD_DOCS_OUTPUT))
@echo "Generating CRD reference documentation"
@$(CRD_REF_DOCS) \
--source-path=./api \
--config=$(CRD_DOCS_CONFIG) \
--renderer=markdown \
--templates-dir=./docs/template \
--output-path=$(CRD_DOCS_OUTPUT) \
--max-depth=100
@echo "CRD reference documentation generated at $(CRD_DOCS_OUTPUT)"

.PHONY: generate-crd-docs-grouped
generate-crd-docs-grouped: manifests ## Generate CRD reference documentation grouped by API group
@mkdir -p docs/crd/groups
@echo "Generating CRD reference documentation (grouped by API)"
@$(CRD_REF_DOCS) \
--source-path=./api \
--config=$(CRD_DOCS_CONFIG) \
--renderer=markdown \
--templates-dir=./docs/template \
--output-path=docs/crd/groups \
--output-mode=group
@echo "CRD reference documentation generated in docs/crd/groups directory"
Loading
Loading