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

CRD reference generation is broken #236

Closed
calebschoepp opened this issue Sep 11, 2024 · 4 comments · Fixed by #242
Closed

CRD reference generation is broken #236

calebschoepp opened this issue Sep 11, 2024 · 4 comments · Fixed by #242
Assignees
Labels
area: CI Improvements or additions to the CI/CD pipeline. bug Something isn't working.

Comments

@calebschoepp
Copy link
Contributor

Problem: We run crd-reference/generate.sh in CI but it doesn't actually do anything because it isn't placing the generate files in the right location. This means that if we don't update the references they fall out of date.

Potential solution: Fix the script to actually place the files in the correct location. This has the downside that it will overwrite the aliases field in the front matter and I don't see a way with Crdoc to insert that. We'd have to write some sed or awk to do that for us.

@calebschoepp calebschoepp added area: CI Improvements or additions to the CI/CD pipeline. bug Something isn't working. labels Sep 11, 2024
@calebschoepp
Copy link
Contributor Author

@bacongobbler how important is it that we keep the aliases on the CRD reference docs? If we could do away with that requirement than fixing this would be fairly straightforward.

@bacongobbler
Copy link
Contributor

I'm not too concerned as long as nobody is currently referencing those aliases in other locations. Those aliases were put in place after spinkube/spin-operator#279 was raised

@bacongobbler
Copy link
Contributor

…Which was fixed in spinkube/spin-operator#286. So it should be fine to remove those aliases.

@calebschoepp
Copy link
Contributor Author

Sweet, more broadly does that mean we don't need those aliases anywhere in the codebase? Because maybe that could be another issue to remove the aliases which would simplify the codebase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: CI Improvements or additions to the CI/CD pipeline. bug Something isn't working.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants