⚠ Generate controllers with API Group name as package names in multi-group projects (only Go plugin v3)

[miguelsorianod]

Description

Use GroupPackageName (the API Group cleaned to be used as
the package name) as the package name when generating
controllers and controller suite test files with
non-empty API groups in MultiGroup projects.

When generating controller with an empty group name in a
MultiGroup project, or when generating a controller in a non
MultiGroup project keep the current behavior, which is
using the controllers package name for both the
controllers and controllers suite test files.

This applies only to Go v3 plugin as I understand this is a breaking change and breaking changes cannot be applied in v2. Can breaking changes be applied to v3 plugin code without the need of creating a new Go v4 plugin version? Is v3 still not considered "released"? By reading the versioning doc (https://github.com/kubernetes-sigs/kubebuilder/blob/master/VERSIONING.md#understanding-the-versions) it seems as if we'd need Go v4 plugin.

Let me know if there's something missing (doc? other stuff that I'm not aware of?)

Motivation

With the behavior before this PR all controllers in a multigroup project defined their package name as "controllers" even when they were inside their own directories. In Go it's often common having the same directory name as the package name (when possible syntactically).

See issue #1717 for more details.

Related Issues

#1717 Controllers in a multigroup project belong to the 'controllers' package

[k8s-ci-robot]

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

---

• If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
• If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
• If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
• Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

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. I understand the commands that are listed here.

[k8s-ci-robot]

Welcome @miguelsorianod!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. 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/kubebuilder 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]

Hi @miguelsorianod. 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.

[camilamacedo86]

Hi @miguelsorianod,

It is great 👍 Could you please follow up the instructions on the comment #1729 (comment)?

/ok-to-test

[camilamacedo86]

Hi @miguelsorianod,

For it gets merged you need to follow up the instructions on the comment #1729 (comment) and squash the commit as well.

[estroz]

/lgtm

[estroz]

For squashing commits

/hold

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: estroz, miguelsorianod

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:

• OWNERS [estroz]

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

[miguelsorianod]

Hi,

I've squashed the commits and it seems the CLA check now passes.

[camilamacedo86]

/hold cancel

[camilamacedo86]

/lgtm