Skip to content

Fix CRD API docs generation script #4152

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

Jump to bottom
Merged
merged 2 commits into from
Apr 15, 2025
Merged

Fix CRD API docs generation script #4152

merged 2 commits into from
Apr 15, 2025

Conversation

0xaravindh
Copy link
Member

@0xaravindh 0xaravindh commented Apr 14, 2025 •
edited
Loading

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking

/kind bug

/kind cleanup
/kind documentation
/kind feature
/kind hotfix
/kind release

What this PR does / Why we need it:

Which issue(s) this PR fixes:

Fixes an error where gen-crd-api-reference-docs couldn't find API packages due to incorrect paths and setup. Updates the script to use the correct working directory, Go version, and template configuration.

F0414 06:51:17.289003     356 main.go:133] no API packages found in ../../../agones.dev/agones/pkg/apis/
make: *** [includes/website.mk:105: gen-api-docs] Error 255

Closes #4150

Special notes for your reviewer:

@0xaravindh 0xaravindh self-assigned this Apr 14, 2025
@github-actions github-actions bot added the kind/bug These are bugs. label Apr 14, 2025
@0xaravindh 0xaravindh requested review from igooch and gongmax April 14, 2025 06:57
@0xaravindh 0xaravindh added the kind/cleanup Refactoring code, fixing up documentation, etc label Apr 14, 2025
@agones-bot
Copy link
Collaborator

Build Failed 😭

Build Id: 347bf5ce-11c4-4afd-b554-143351873557

Status: FAILURE

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

@0xaravindh
Copy link
Member Author

/gcbrun

@agones-bot
Copy link
Collaborator

Build Failed 😭

Build Id: bfdc7364-1108-43b6-9db4-84b92e068c38

Status: FAILURE

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

@0xaravindh
Copy link
Member Author

/gcbrun

@agones-bot
Copy link
Collaborator

Build Failed 😭

Build Id: 9b458c60-b6df-4838-9af9-96d921fc66fc

Status: FAILURE

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

@0xaravindh
Copy link
Member Author

#4150 Issue is resolved—DeleteValues is now showing up as expected.

57f9xNDiKEKkKqy

@0xaravindh 0xaravindh requested a review from markmandel April 14, 2025 15:48
@igooch
Copy link
Collaborator

igooch commented Apr 14, 2025

/gcbrun

@agones-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: 172c19eb-da38-4f2f-8754-6f6a359b2192

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4152/head:pr_4152 && git checkout pr_4152
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.49.0-dev-e6fc1ee

markmandel
markmandel reviewed Apr 15, 2025
View reviewed changes
site/gen-api-docs.sh
@@ -16,23 +16,11 @@

set -ex

#Reinstall Go 1.15 since the version upon it won't work with gen-crd-api-reference-docs
rm -rf /usr/local/go
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh nice, glad that got updated and fixed.

@markmandel markmandel enabled auto-merge (squash) April 15, 2025 04:06
@agones-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: 0bc9dd30-ff89-4939-b56e-f8f697a749ec

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4152/head:pr_4152 && git checkout pr_4152
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.49.0-dev-6a8b190

@markmandel markmandel merged commit a8a5950 into googleforgames:main Apr 15, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@markmandel markmandel markmandel approved these changes

@igooch igooch Awaiting requested review from igooch

@gongmax gongmax Awaiting requested review from gongmax

Assignees

@0xaravindh 0xaravindh

Labels
kind/bug These are bugs. kind/cleanup Refactoring code, fixing up documentation, etc
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ListAction DeleteValues doesn't show up on the generated API reference
4 participants
@0xaravindh @agones-bot @igooch @markmandel