✨ (API, CLI, go/v4) Add cliVersion field to the PROJECT file configuration to store the CLI binary version used to scaffold projects.

[vitorfloriano]

This PR adds a new field to the PROJECT file: cliVersion.

Additionally, it updates the documentation in the Project Configuration Reference to include the new cliVersion field.

It also updates the PROJECT file scaffolded in the docs and in testdata.

Closes: #4398

Test Steps:

1. Build a snapshot release using GoReleaser:

~/kubebuilder$ goreleaser release --snapshot --skip=publish -f ./build/.goreleaser.yml

2. Create a new test project directory:

mkdir -p ~/projects/test-project-file && cd ~/projects/test-project-file

3. Initialize the test project using the Kubebuilder snapshot:

~/kubebuilder/dist/kubebuilder_linux_amd64_v1/kubebuilder init --domain example.com --repo github.com/test/example-operator

4. Verify the generated PROJECT file:

$ cat PROJECT 
# 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
cliVersion: 4.5.1-SNAPSHOT-6ab4d371b
domain: example.com
layout:
- go.kubebuilder.io/v4
projectName: test-project-file
repo: github.com/test/example-operator
version: "3"

[k8s-ci-robot]

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

[camilamacedo86]

Terrific 🎉 . Thank you a lot for your contribution 🥇

[knabben]

needs rebase, do a git pull from main locally, git rebase on your branch and solve any conflict..

[camilamacedo86]

Hi @vitorfloriano IMO it is very close to fly 🚀
Just a couple of details see above the latest comments and then I am OK with.

[camilamacedo86]

✅ This change seems safe to approve.

The package sigs.k8s.io/kubebuilder/v4/pkg/config/v3 is used directly by consumers, but in practice they usually do not implement the Config interface themselves. Instead, they rely on the provided implementation, such as cfgv3.Cfg.

As a result, adding the GetCliVersion and SetCliVersion methods to the interface is not a breaking change for consumers who simply use the config objects. These consumers won't need to do anything differently.

However, if a project chooses to implement the Config interface themselves, they would now be required to implement the new methods. For example:

type MyCustomConfig struct {
    // fields...
}

func (c *MyCustomConfig) GetCliVersion() string {
    return "v4.6.0"
}

func (c *MyCustomConfig) SetCliVersion(version string) error {
    // optionally store it somewhere
    return nil
}

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

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

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 [camilamacedo86]

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

[camilamacedo86]

Furtheremore, we also validate the change here: #4760 (comment)