implemented a CI check to validate code generation by katara-Jayprakash · Pull Request #225 · volcano-sh/apis

katara-Jayprakash · 2026-01-17T17:57:13Z

gemini-code-assist · 2026-01-17T17:57:30Z

Summary of Changes

Hello @katara-Jayprakash, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's development workflow by integrating robust Continuous Integration (CI) checks. It automates the validation of generated client code and ensures API compatibility, preventing common issues before they merge. The changes also include detailed documentation and new Makefile targets, making it easier for developers to maintain code quality and troubleshoot CI failures locally.

Highlights

New CI Checks: Implemented new Continuous Integration (CI) checks to validate code generation and ensure API compatibility, enhancing code quality and consistency.
Comprehensive CI Documentation: Added a new CI.md file that provides detailed documentation on CI/CD workflows, local development commands, required tools, and troubleshooting steps for API-related issues.
Makefile Enhancements: Introduced several new Makefile targets to streamline code generation, API validation, building, testing, and cleaning processes for local development and CI.
Dependency Updates: Updated various Go module dependencies in go.mod and go.sum to their latest versions, including testing frameworks and Kubernetes code generation tools.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Ignored Files

Ignored by pattern: .github/workflows/** (2)
- .github/workflows/api-compatibility.yaml
- .github/workflows/codegen-check.yaml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a CI check to validate code generation, along with supporting Makefile targets, scripts, and documentation. The changes are well-structured and improve the development workflow by automating validation.

My review includes suggestions to improve the new scripts and Makefile for robustness and maintainability. Specifically, I've pointed out a redundant and inefficient command in the verification script, suggested turning soft warnings into hard errors for more reliable CI feedback, and recommended adding a standard help target to the Makefile. I've also noted some minor stylistic issues like missing newlines at the end of new files.

I am having trouble creating individual review comments. Click here to see my feedback.

hack/verify-api-compatibility.sh (10-13)

This go vet command is redundant because the api-lint target in the Makefile already performs this check. Additionally, running go vet on individual files with find ... -exec is less effective than go vet ./... on a package, as the latter can perform more comprehensive cross-file analysis.

To avoid duplication and use the more effective command, please remove this block from the script. The api-lint target should be the single source for running go vet.

hack/verify-api-compatibility.sh (21-32)

The checks for required files (doc.go, register.go, zz_generated.deepcopy.go) only print a warning. In a CI environment, warnings are often overlooked. Since these files are essential for a valid API definition, their absence should result in a hard failure.

Please change these checks to print an error message to stderr and exit with a non-zero status code to ensure the CI job fails correctly.

For example:

if [ ! -f "$api_dir/doc.go" ]; then
    echo "Error: Missing doc.go in $api_name/$version" >&2
    exit 1
fi

This should be applied to all three file existence checks.

CI.md (109)

The file is missing a newline character at the end. It's a common convention to end files with a newline, and some tools might flag this as an issue.

- Ensure all imports are correct

Makefile (1)

The .PHONY target help is declared but not defined. It's a common and good practice to provide a help target in a Makefile to list available commands and their purpose. This improves discoverability and usability for developers.

Here's an example of a simple help target you could add:

help:
	@echo "Usage: make [target]"
	@echo
	@echo "Targets:"
	@echo "  update-codegen  - Update generated code"
	@echo "  verify-codegen  - Verify generated code is up to date"
	@echo "  api-lint        - Run API linting"
	@echo "  api-compat      - Check API compatibility"
	@echo "  build           - Build all packages"
	@echo "  test            - Run tests"
	@echo "  clean           - Clean build artifacts"

Makefile (33)

The file is missing a newline character at the end. It's a common convention to end files with a newline.

	rm -rf _tmp/ bin/

hack/verify-api-compatibility.sh (36)

The file is missing a newline character at the end. It's a common convention to end files with a newline.

echo "API compatibility check completed"

hack/verify-codegen.sh

hzxuzhonghu · 2026-01-19T03:37:40Z

go.sum

-github.com/onsi/gomega v1.35.1 h1:Cwbd75ZBPxFSuZ6T+rN/WCb/gOc6YgFBXLlZLhC7Ds4=
-github.com/onsi/gomega v1.35.1/go.mod h1:PvZbdDc8J6XJEpDK4HCuRBm8a6Fzp9/DmhC9C7yFlog=
+github.com/onsi/ginkgo/v2 v2.23.4 h1:ktYTpKJAVZnDT4VjxSbiBenUjmlL/5QkBEocaWXiQus=
+github.com/onsi/ginkgo/v2 v2.23.4/go.mod h1:Bt66ApGPBFzHyR+JO10Zbt0Gsp4uWxu5mIOTusL46e8=


this is synced from volcano core repo

ok keep that in mind, but thought it would be great to update this or should we update this into volcano core too?

.github/workflows/api-compatibility.yaml

.github/workflows/codegen-check.yaml

hzxuzhonghu · 2026-01-19T03:39:44Z

.github/workflows/codegen-check.yaml

+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+      - run: ./hack/verify-codegen.sh


we have a gen check workflow in volcano-sh/volcano

I donot mind addong one in apis repo

Signed-off-by: katara-Jayprakash <[email protected]>

katara-Jayprakash · 2026-01-24T09:23:57Z

/cc @hzxuzhonghu i think we are ready for new review sir!

hzxuzhonghu · 2026-01-26T02:44:08Z

.github/workflows/api-compatibility.yaml

+      - name: Install crdify
+        run: go install sigs.k8s.io/crdify@latest
+
+      - name: Validate API structure


we donot need this verify here

/cc @hzxuzhonghu fixed in next commit sir! thanx

Signed-off-by: katara-Jayprakash <[email protected]>

hzxuzhonghu · 2026-01-27T02:31:40Z

.github/workflows/api-compatibility.yaml

+        continue-on-error: true
+
+      - name: Install crdify
+        run: go install sigs.k8s.io/crdify@latest


I am not sure what you are doing here?

this one, ya lemme clarify this is additional requirement ask by @JesseStutler in issue section,
Use tools like https://github.com/kubernetes-sigs/kube-api-linter and https://github.com/kubernetes-sigs/crdify to check API changes. API changes must be compatible, and certain fields must follow specified rules so i endedup adding them too, @hzxuzhonghu

You just install this tool without calling it

we got two things, remove the whole tool or add the tool , i choose to keep it and use it in codebase in next commit!

hzxuzhonghu · 2026-01-27T03:39:30Z

go.mod

 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/google/gnostic-models v0.7.0 // indirect
 	github.com/google/go-cmp v0.7.0 // indirect
+	github.com/google/pprof v0.0.0-20250607225305-033d6d78b36a // indirect


donot change the go mod, it is synced from volcano-sh/volcano repo

@hzxuzhonghu fixed sir! ready for final review!

Signed-off-by: katara-Jayprakash <[email protected]>

hzxuzhonghu · 2026-01-30T03:53:47Z

.github/workflows/api-compatibility.yaml

+        run: go install sigs.k8s.io/crdify@latest
+
+      - name: Fetch base branch for comparison
+        run: git fetch origin ${{ github.base_ref }} --depth=1


?? what does this do

ok, so the thing i am trying to catch breaking API changes (removed fields, changed types,) before merge by installing crdify tool. If we prefer manual API review, I can remove crdify and keep only the basic checks like gofmt

the CI runner only has PR code. It needs master to compare against so i am fetching it and comparing it with master

I would recommend removing this workflow, all the code are generated, ans synced from volcano repo. It is too late to check compatability here.

ahh make sense, this workflow was suggest by jesse sir, so i'm doing it.

hzxuzhonghu · 2026-01-30T09:26:16Z

Makefile

+verify-codegen:
+	./hack/verify-codegen.sh
+
+api-lint:


hzxuzhonghu · 2026-01-30T09:26:32Z

Makefile

+crd-gen:
+	@echo "Validating API structure with crdify..."
+	go install sigs.k8s.io/crdify@latest
+	~/go/bin/crdify --help || echo "crdify installed"


Signed-off-by: katara-Jayprakash <[email protected]>

hzxuzhonghu

/lgtm

volcano-sh-bot · 2026-01-31T03:07:53Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: hzxuzhonghu
Once this PR has been reviewed and has the lgtm label, please assign thor-wl for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

katara-Jayprakash · 2026-01-31T08:06:25Z

@JesseStutler i think we can merge this sir! thanx

volcano-sh-bot requested review from JesseStutler and william-wang January 17, 2026 17:57

volcano-sh-bot added the size/L label Jan 17, 2026

gemini-code-assist bot reviewed Jan 17, 2026

View reviewed changes

volcano-sh-bot added the do-not-merge/contains-merge-commits label Jan 17, 2026

katara-Jayprakash force-pushed the feature/add-ci-workflows branch from 70d2803 to b2c58ca Compare January 17, 2026 18:28

volcano-sh-bot removed the do-not-merge/contains-merge-commits label Jan 17, 2026

hzxuzhonghu reviewed Jan 19, 2026

View reviewed changes

hack/verify-codegen.sh Show resolved Hide resolved

hzxuzhonghu reviewed Jan 19, 2026

View reviewed changes

.github/workflows/api-compatibility.yaml Outdated Show resolved Hide resolved

hzxuzhonghu reviewed Jan 19, 2026

View reviewed changes

.github/workflows/codegen-check.yaml Outdated Show resolved Hide resolved

hzxuzhonghu reviewed Jan 19, 2026

View reviewed changes

katara-Jayprakash added 4 commits January 24, 2026 14:47

ci: add API validation and code generation workflows

015ead5

Signed-off-by: katara-Jayprakash <[email protected]>

add Makefile

8f3e5e8

Signed-off-by: katara-Jayprakash <[email protected]>

deps: update dependencies for CI tools

68dc4a1

Signed-off-by: katara-Jayprakash <[email protected]>

refactor: remove unused generate-internal-groups script

c737989

Signed-off-by: katara-Jayprakash <[email protected]>

katara-Jayprakash force-pushed the feature/add-ci-workflows branch from cda899a to c737989 Compare January 24, 2026 09:20

ci: fix codegen script execution permission

6f44c9f

Signed-off-by: katara-Jayprakash <[email protected]>

hzxuzhonghu reviewed Jan 26, 2026

View reviewed changes

Removing api-structure from workflow

ea7435d

Signed-off-by: katara-Jayprakash <[email protected]>

hzxuzhonghu reviewed Jan 27, 2026

View reviewed changes

adding crdify and synced go-mod and go-sum with volcano-repo

29baf97

Signed-off-by: katara-Jayprakash <[email protected]>

katara-Jayprakash requested a review from hzxuzhonghu January 27, 2026 04:08

hzxuzhonghu reviewed Jan 30, 2026

View reviewed changes

removing unwanted from makefiles

73f8644

Signed-off-by: katara-Jayprakash <[email protected]>

katara-Jayprakash added 2 commits January 30, 2026 15:04

removing things

f4a4fe0

Signed-off-by: katara-Jayprakash <[email protected]>

removing api

f4868b2

Signed-off-by: katara-Jayprakash <[email protected]>

katara-Jayprakash requested a review from hzxuzhonghu January 30, 2026 14:20

hzxuzhonghu approved these changes Jan 31, 2026

View reviewed changes

volcano-sh-bot assigned hzxuzhonghu Jan 31, 2026

volcano-sh-bot added the lgtm label Jan 31, 2026

Conversation

katara-Jayprakash commented Jan 17, 2026

Uh oh!

gemini-code-assist bot commented Jan 17, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

hack/verify-api-compatibility.sh (10-13)

hack/verify-api-compatibility.sh (21-32)

CI.md (109)

Makefile (1)

Makefile (33)

hack/verify-api-compatibility.sh (36)

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

katara-Jayprakash commented Jan 24, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

katara-Jayprakash Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hzxuzhonghu left a comment

Choose a reason for hiding this comment

Uh oh!

volcano-sh-bot commented Jan 31, 2026

Uh oh!

katara-Jayprakash commented Jan 31, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

katara-Jayprakash Jan 26, 2026 •

edited

Loading