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.

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

Migrate to use kube_codegen.sh to generate client #329

Merged
merged 4 commits into from
Nov 15, 2023
Merged

Migrate to use kube_codegen.sh to generate client #329

merged 4 commits into from
Nov 15, 2023

Conversation

ashnehete
Copy link
Contributor

Fixes #305

Updates hack/update-codegen.sh to use new kube_codegen.sh from k8s.io/code-generator.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 9, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @ashnehete!

It looks like this is your first PR to kubernetes-sigs/jobset 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/jobset has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 9, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @ashnehete. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 9, 2023
ashnehete
ashnehete commented Nov 9, 2023
View reviewed changes
hack/update-codegen.sh Outdated
--input-pkg-root sigs.k8s.io/jobset/api \
--output-base "$REPO_ROOT" \
--output-pkg-root sigs.k8s.io/jobset/client-go \
--boilerplate "${REPO_ROOT}/hack/boilerplate.go.txt"

# if client-go files were generated outside of repo root, attempt to move them to the repo root.
CLIENT_GO=$(find $GOPATH -regextype sed -regex ".*jobset.*client-go")
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure if we need this part anymore. Can anyone please confirm?

Copy link
Contributor

Choose a reason for hiding this comment

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

Why do you think it is not needed? In the past we've encountered issues where the generated client-go files appear in different locations in the filesystem in different environments, so we have this logic to move the files to the correct location if they end up somewhere in $GOROOT

Copy link
Contributor

Choose a reason for hiding this comment

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

@ashnehete change is trying to fix that issue.

Both Kueue and Jobset ran into this issue: kubernetes/code-generator#165.

So I guess the solution is to add a symbolic link for CWD into sigs.k8s.io.

So what this change does is we should be generating everything into our CWD, but I guess we trick codegen to assume that its actually in sigs.k8s.io.

Copy link
Contributor

Choose a reason for hiding this comment

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

I see, in that case yes feel free to remove this logic once you've tested manually and confirmed the symbolic link trick works.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The new kube_codegen.sh script seems to be enforcing the output location as specified. I have tested the code manually on MacOS and Ubuntu (Docker).

Copy link
Contributor

Choose a reason for hiding this comment

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

I also pulled this branch and did a quick test with my setup. I added a dummy api and I was able to confirm that this generates both client-go and python code.

I don't think I tested any changes where the client-go copying was disabled though.

@danielvegamyhre
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 9, 2023
@danielvegamyhre
Copy link
Contributor

Hi @ashnehete, I will take a look at this tomorrow

@kannon92
Copy link
Contributor

So I cloned this branch and did some quick testing.

My work is usually cloned to /home/kehannon/Work/jobset.

I added a comment to a API, ran make generate manfest, and I saw both client-go and python-sdk files edited in tree.

I think this PR is good to go.

/lgtm

@danielvegamyhre any other things you'd want to see from the PR?

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 13, 2023
@danielvegamyhre
Copy link
Contributor

Thanks for testing @kannon92

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ashnehete, danielvegamyhre

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

The pull request process is described here

Needs approval from an approver in each of these files:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 15, 2023
@k8s-ci-robot k8s-ci-robot merged commit 2466090 into kubernetes-sigs:main Nov 15, 2023
@danielvegamyhre danielvegamyhre mentioned this pull request Dec 12, 2023
Closed
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kannon92 kannon92 kannon92 left review comments

@ahg-g ahg-g Awaiting requested review from ahg-g

@danielvegamyhre danielvegamyhre Awaiting requested review from danielvegamyhre

Assignees

@kannon92 kannon92

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Migrate to use kube_codegen.sh
4 participants
@ashnehete @k8s-ci-robot @danielvegamyhre @kannon92