Skip to content

CLOUDP-336726: Autogenerate API Docs #2711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
roothorp merged 5 commits into from
Oct 2, 2025
Merged

CLOUDP-336726: Autogenerate API Docs #2711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ca7d53f
add crdoc automation
roothorp Sep 22, 2025
972f9ce
move crdoc tool into its own go.mod
roothorp Sep 22, 2025
142d659
rename tools go.mod to toolbox
roothorp Sep 22, 2025
d1b3bdf
use modfile flag for go tool
roothorp Oct 2, 2025
17e207d
go mod tidy
roothorp Oct 2, 2025
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
1 change: 1 addition & 0 deletions .github/workflows/release-image.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/validate-manifests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
13 changes: 10 additions & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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..."
Expand All @@ -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
Loading