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.

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

🌱 fix: centralize plugin key declaration #4390

Conversation

mateusoliveira43
Copy link
Contributor

@mateusoliveira43 mateusoliveira43 commented Nov 25, 2024

Why the changes were made

Fix #4309

How the changes were made

Ran these commands to find occurrences

grep -Inr "base.go.kubebuilder.io" . --exclude=\*.{md,sh,toml}
grep -Inr "base/v4" . --exclude=\*.{md,sh,toml}
grep -Inr "deploy-image.go.kubebuilder.io" . --exclude=\*.{md,sh,toml}
grep -Inr "deploy-image/v1-alpha" . --exclude=\*.{md,sh,toml}
grep -Inr "grafana.kubebuilder.io" . --exclude=\*.{md,sh,toml}
grep -Inr "grafana/v1-alpha" . --exclude=\*.{md,sh,toml}
grep -Inr "helm.kubebuilder.io" . --exclude=\*.{md,sh,toml}
grep -Inr "helm/v1-alpha" . --exclude=\*.{md,sh,toml}
grep -Inr "kustomize.common.kubebuilder.io" . --exclude=\*.{md,sh,toml}
grep -Inr "kustomize/v2" . --exclude=\*.{md,sh,toml}
grep -Inr "sampleexternalplugin" . --exclude=\*.{md,sh,toml}
grep -Inr "sampleexternalplugin/v1" . --exclude=\*.{md,sh,toml}
grep -Inr "go.kubebuilder.io" . --exclude=\*.{md,sh,toml}
grep -Inr "go/v4" . --exclude=\*.{md,sh,toml}

ignoring test files.

Note: go.kubebuilder.io plugin is defined in cmd/main.go and could not change here because of import cycle

gov4 := "go.kubebuilder.io/v4"

Note: could not change here because of import cycle

codeFence(fmt.Sprintf("%s edit --plugins=helm/v1-alpha", f.CommandName)),

Note: did not find where sampleexternalplugin/v1 plugin key is defined to dynamically inject here https://github.com/kubernetes-sigs/kubebuilder/tree/c32f9714456f7e5e7cc6c790bb87c7e5956e710b/docs/book/src/simple-external-plugin-tutorial/testdata/sampleexternalplugin/v1/scaffolds

Note: did not change here

%[1]s init --plugins go/v4 --domain example.org --owner "Your name"
%[1]s init --plugins go/v4 --project-version 3
because of #4395

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

Hi @mateusoliveira43. 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 25, 2024
@@ -31,21 +31,19 @@ import (
"sigs.k8s.io/kubebuilder/v4/pkg/config/store/yaml"
"sigs.k8s.io/kubebuilder/v4/pkg/machinery"
"sigs.k8s.io/kubebuilder/v4/pkg/model/resource"
"sigs.k8s.io/kubebuilder/v4/pkg/plugin"
"sigs.k8s.io/kubebuilder/v4/pkg/plugin/util"
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/deploy-image/v1alpha1"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

separate PR, but deploy-image plugin folder should be v1alpha instead of v1alpha1?

Copy link
Member

Choose a reason for hiding this comment

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

To change that, we would break our APIs
So, let's keep it as it is until the day that we need to create another API and etc

@mateusoliveira43
Copy link
Contributor Author

/hold saw that there multiple ways to call a plugin. Example: deploy-image/v1-alpha or deploy-image.go.kubebuilder.io/v1-alpha work for deploy-image plugin

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 25, 2024
@camilamacedo86
Copy link
Member

/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 25, 2024
Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>
@mateusoliveira43 mateusoliveira43 force-pushed the fix/centralize-plugin-key branch from 03ccaeb to 9fa1285 Compare November 26, 2024 17:59
@mateusoliveira43
Copy link
Contributor Author

/unhold

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 26, 2024
Copy link
Member

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

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

I looked at the code it shows all fine 🥇
Also, it is passing in the tests and we still scaffolding the samples and all at the same way to it seems a quite improvement and we are face to fly 🚀

/lgtm
/approve

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, mateusoliveira43

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 27, 2024
@k8s-ci-robot k8s-ci-robot merged commit cbc6e38 into kubernetes-sigs:master Nov 27, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

Cleanup: Centralize Plugin Names in Plugin Interfaces
3 participants