Add kubebuilderVersion Field in PROJECT File for Tracking Kubebuilder CLI Version

[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:

• Help identify the tooling version employed, aiding in troubleshooting and ensuring compatibility with updates.
• Provide developers with clearer insights into their project's setup for efficient maintenance and evolution.
• Support solutions like PR #4302 and align with broader goals for traceability and user support.

Tasks:

1. Add a new field in the PROJECT file: kubebuilderVersion.
2. Ensure the field tracks the Kubebuilder tool version used during scaffolding.
3. Update the documentation in the Project Configuration Reference to include the new kubebuilderVersion field.

Reference Files:

• Example PROJECT file: PROJECT File
• Documentation: Project Config Docs

This change aims to improve traceability and simplify workflows for users and maintainers.

Extra Labels

No response

[camilamacedo86]

We are open to better name suggestions as well !!

[rovertrack]

can i try to solve this

[mateusoliveira43]

@rovertrack just comment here /assign and the issue will be assigned to you (so that 2 people do not work on the same task)

if you need any help, just ping here or in the PR

[rovertrack]

/assign

[rovertrack]

where the kubebuilderVersion has to be in the projectfile

[mateusoliveira43]

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 version

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"

[rovertrack]

👍

[sureshkrishnan-v]

/assign

[jameskim0987]

@camilamacedo86 @mateusoliveira43 Hi, I was just browsing through issues with good first issue and came across this issue and (#4297) with the hopes of contributing 😄 but I see that we already have 2 assignees.

May I suggest we have the k8s-ci-robot limit to 1 asignee max per issue? and reject future /assign commands if there is an assignee already? This way, we know who is working on it and prevent other folks from just snatch it..

[camilamacedo86]

Hi @jameskim0987,

It’s possible they are working together—more than one person can collaborate on a task.
That it is why I think is not a good idea.

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:

• Reaching out to the assignee directly.
• Sending a quick ping in Slack to check if they’re stuck or need assistance.
• Offering to help if the other person cannot move forward.
• This way, we can keep things moving and avoid blockers.

[jameskim0987]

@camilamacedo86 Got it. Thank you for providing clarity on this matter.