Skip to content
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.

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

Broken generate-crd-reference-docs Makefile target #10568

Open
timflannagan opened this issue Jan 31, 2025 · 1 comment
Open

Broken generate-crd-reference-docs Makefile target #10568

timflannagan opened this issue Jan 31, 2025 · 1 comment

Comments

@timflannagan
Copy link
Member

When I run the generate-crd-reference-docs target locally, I see the following output:

make generate-crd-reference-docs                                  
go run docs/content/crds/generate.go
2 errors occurred:
	* "go" "run" "fybrik.io/crdoc" "--resources" "install/helm/gloo/crds/gateway.kgateway.dev_gatewayparameters.yaml" "--output" "docs/content/reference/api/github.com/solo-io/gloo/projects/gateway2/api/v1alpha1/gateway_parameters.md" "--template" "docs/content/crds/templates/markdown.tmpl" produced error command ""go" "run" "fybrik.io/crdoc" "--resources" "install/helm/gloo/crds/gateway.kgateway.dev_gatewayparameters.yaml" "--output" "docs/content/reference/api/github.com/solo-io/gloo/projects/gateway2/api/v1alpha1/gateway_parameters.md" "--template" "docs/content/crds/templates/markdown.tmpl"" failed with error: exit status 1: exit status 1
	* "go" "run" "fybrik.io/crdoc" "--resources" "install/helm/gloo/crds/gateway.kgateway.dev_directresponses.yaml" "--output" "docs/content/reference/api/github.com/solo-io/gloo/projects/gateway2/api/v1alpha1/direct_responses.md" "--template" "docs/content/crds/templates/markdown.tmpl" produced error command ""go" "run" "fybrik.io/crdoc" "--resources" "install/helm/gloo/crds/gateway.kgateway.dev_directresponses.yaml" "--output" "docs/content/reference/api/github.com/solo-io/gloo/projects/gateway2/api/v1alpha1/direct_responses.md" "--template" "docs/content/crds/templates/markdown.tmpl"" failed with error: exit status 1: exit status 1


exit status 1
make: *** [Makefile:333: generate-crd-reference-docs] Error 1

This check was disabled from codegen in #10492. Additionally, we should decide whether we want to rip out the CRD related tools in ci/tools.go or decide on a single tool that fixes the reference docs automation: #10561 (comment).

@timflannagan
Copy link
Member Author

Potentially a sub-issue under #10496.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant