Skip to content

build: improve test-gen-api-docs failure message#4453

Merged
markmandel merged 1 commit intoagones-dev:mainfrom
markmandel:test/gen-api-docs
Feb 23, 2026
Merged

build: improve test-gen-api-docs failure message#4453
markmandel merged 1 commit intoagones-dev:mainfrom
markmandel:test/gen-api-docs

Conversation

@markmandel
Copy link
Copy Markdown
Collaborator

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:

When the API docs diff fails, print a clear error message telling the user to run 'make gen-api-docs' since the CRD information in /pkg/apis has changed.

Which issue(s) this PR fixes:

N/A

Special notes for your reviewer:

Just making it easier for people to know why this test fails.

When the API docs diff fails, print a clear error message telling the
user to run 'make gen-api-docs' since the CRD information in /pkg/apis
has changed.
@github-actions github-actions bot added the kind/cleanup Refactoring code, fixing up documentation, etc label Feb 23, 2026
@markmandel markmandel added the area/tests Unit tests, e2e tests, anything to make sure things don't break label Feb 23, 2026
@agones-bot
Copy link
Copy Markdown
Collaborator

Build Succeeded 🥳

Build Id: 56724f50-1549-4b93-a5a5-0970be004a5c

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/4453/head:pr_4453 && git checkout pr_4453
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.56.0-dev-8ab7c6e

Copy link
Copy Markdown
Collaborator

@igooch igooch left a comment

Choose a reason for hiding this comment

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

LGTM

@markmandel markmandel merged commit 35f5457 into agones-dev:main Feb 23, 2026
5 checks passed
@markmandel markmandel deleted the test/gen-api-docs branch February 23, 2026 16:18
mnthe pushed a commit to mnthe/agones that referenced this pull request Mar 23, 2026
When the API docs diff fails, print a clear error message telling the
user to run 'make gen-api-docs' since the CRD information in /pkg/apis
has changed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tests Unit tests, e2e tests, anything to make sure things don't break kind/cleanup Refactoring code, fixing up documentation, etc size/XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants