CLOUDP-336726: Autogenerate API Docs (#2711)

* add crdoc automation

* move crdoc tool into its own go.mod

* rename tools go.mod to toolbox

* use modfile flag for go tool

* go mod tidy

Author: roothorp

.github/workflows/release-image.yml

@@ -289,6 +289,7 @@ jobs:
           cp -rf helm-charts "$RELEASE_DIR/"
           cp bundle.Dockerfile "$RELEASE_DIR/bundle.Dockerfile"
           cp licenses.csv "$RELEASE_DIR/"
+          cp docs/api-docs.md "$RELEASE_DIR/"
 
           git fetch origin
           git checkout -f -b "$BRANCH" origin/main

.github/workflows/validate-manifests.yml

@@ -16,4 +16,4 @@ jobs:
         with:
           enable-cache: 'true'
       - name: Run testing
-        run: devbox run -- 'make validate-manifests'
+        run: devbox run -- 'make validate-manifests validate-api-docs'

Makefile

@@ -296,7 +296,7 @@ ifneq ($(shell git ls-files -o -m --directory --exclude-standard --no-empty-dire
 	$(info Detected files that need to be committed:)
 	$(info $(shell git ls-files -o -m --directory --exclude-standard --no-empty-directory | sed -e "s/^/  /"))
 	$(info )
-	$(info Try running: make generate manifests)
+	$(info Try running: make generate manifests api-docs)
 	$(error Check: FAILED)
 else
 	$(info Check: PASS)
@@ -650,7 +650,6 @@ tools/githubjobs/githubjobs: tools/githubjobs/*.go
 tools/scandeprecation/scandeprecation: tools/scandeprecation/*.go
 	cd tools/scandeprecation && go test . && go build .
 
-
 .PHONY: slack-deprecations
 slack-deprecations: tools/scandeprecation/scandeprecation tools/githubjobs/githubjobs
 	@echo "Computing and sending deprecation report to Slack..."
@@ -663,4 +662,12 @@ bump-version-file:
 	jq '(.next | split(".") | map(tonumber) | .[1] += 1 | .[2] = 0 | map(tostring) | join(".")) as $$new_next | .current = .next | .next = $$new_next' $(VERSION_FILE) > $(VERSION_FILE).tmp && mv $(VERSION_FILE).tmp $(VERSION_FILE)
 
 	@echo "Version updated successfully:"
-	@cat $(VERSION_FILE)
+	@cat $(VERSION_FILE)
+
+.PHONY: api-docs
+api-docs:
+	 go tool -modfile=tools/toolbox/go.mod crdoc --resources config/crd/bases --output docs/api-docs.md
+
+.PHONY: validate-api-docs
+validate-api-docs: api-docs
+	$(MAKE) check-missing-files