-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Add kubebuilderVersion Field in PROJECT File for Tracking Kubebuilder CLI Version #4398
Comments
We are open to better name suggestions as well !! |
can i try to solve this |
@rovertrack just comment here if you need any help, just ping here or in the PR |
/assign |
where the kubebuilderVersion has to be in the projectfile |
currently, a sample PROJECT file looks like this # Code generated by tool. DO NOT EDIT.
# This file is used to track the info used to scaffold your project
# and allow the plugins properly work.
# More info: https://book.kubebuilder.io/reference/project-config.html
domain: openshift.io
layout:
- go.kubebuilder.io/v4
projectName: oadp-nac
repo: github.com/migtools/oadp-non-admin
resources:
- api:
crdVersion: v1
namespaced: true
controller: true
domain: openshift.io
group: oadp
kind: NonAdminBackup
path: github.com/migtools/oadp-non-admin/api/v1alpha1
version: v1alpha1
version: "3" I think it makes sense to be a high level information, like It would look like this then # Code generated by tool. DO NOT EDIT.
# This file is used to track the info used to scaffold your project
# and allow the plugins properly work.
# More info: https://book.kubebuilder.io/reference/project-config.html
domain: openshift.io
layout:
- go.kubebuilder.io/v4
projectName: oadp-nac
repo: github.com/migtools/oadp-non-admin
resources:
- api:
crdVersion: v1
namespaced: true
controller: true
domain: openshift.io
group: oadp
kind: NonAdminBackup
path: github.com/migtools/oadp-non-admin/api/v1alpha1
version: v1alpha1
version: "3"
kubebuilderVersion: "3.14.2" |
👍 |
/assign |
@camilamacedo86 @mateusoliveira43 Hi, I was just browsing through issues with May I suggest we have the |
Hi @jameskim0987, It’s possible they are working together—more than one person can collaborate on a task. That said, it’s also common for someone to assign themselves to an issue but later be unable to follow through due to unforeseen circumstances. To address this, I usually monitor tasks that have been assigned but remain inactive for some time. Afterward, I reach out to the assignees to check in. I also encourage contributors to be proactive by:
|
@camilamacedo86 Got it. Thank you for providing clarity on this matter. |
Are you both working on this one? |
/assign |
/unassign |
/assign |
@camilamacedo86 I suspect this change would go with adding Along with that you need to test it out locally as mentioned here |
Yes, that is the final result that we want.
This change/RFE will be helpful for the WIP proposal because we will need to know what version was used to do the original scaffold, but this task itself has no dependency within it. |
@akagami-harsh Are you working on this one? Need any help? |
/assign |
@camilamacedo86 I'm curious about how this new field will be handled in existing projects. Will it only be added during initial scaffolding, or should we also check for and update it when making changes to an existing project? I guess it wouldn't be safe to assume that the version used to update the project is the same that was used for scaffolding, right? 🤔 But I still think it could be useful to track the CLI version even during updates because it can help with troubleshooting and compatibility issues. If someone updates their project with a newer version of Kubebuilder, knowing that version along with the original version could be helpful. But I guess that's an issue for another time. 😉 |
@vitorfloriano I was thinking about this Should we add check, during execution of any command that would touch ExampleI created project with kubebuilder version We could error operation saying user must use same version used to scaffold the project to scaffold new code, pointing to documentation on how to update code. We could also add in error message if the user wants to override this check, just manually add/update kubebuilder version in This can be done in a separate issue as well, if agreed. cc @camilamacedo86 |
What do you want to happen?
Description:
To enhance project traceability and facilitate future upgrades, it's proposed that Kubebuilder's
PROJECT
file includes a new field,kubebuilderVersion
, to record the specific CLI version used during project scaffolding. This addition will:Tasks:
PROJECT
file:kubebuilderVersion
.kubebuilderVersion
field.Reference Files:
PROJECT
file: PROJECT FileThis change aims to improve traceability and simplify workflows for users and maintainers.
Extra Labels
No response
The text was updated successfully, but these errors were encountered: