Kubebuilder: Documentation needed for `+kubebuilder:scaffold` markers

[AKarbas]

Hi!

Please add documentation about the +kubebuilder:scaffold markers.

I came across this in the main.go generated file of a project I'm currently working on, where there's this line in the imports section, which apparently helps Kubebuilder put import statements there when you create new api-versions.

// +kubebuilder:scaffold:imports

Possible landing spots in CronJob tutorial or in markers reference.

Thanks to @djzager and @estroz for your help in Slack. 🙏

Cheers

/kind documentation

[estroz]

/remove-kind feature
/assign

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[estroz]

/remove-lifecycle stale

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[AKarbas]

If I may,
/remove-lifecycle stale

[bilalcaliskan]

Is there any progress about that? I still do not know about // +kubebuilder:scaffold:builder, // +kubebuilder:scaffold:scheme or // +kubebuilder:scaffold:imports. There is no such information about them.

Thanks.

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

[camilamacedo86]

/remove-lifecycle stale

[adambkaplan]

Agree that this docs on these markers are needed. For example, what does the kubebuilder:scaffold:scheme marker do? Can I add other schemes besides the ones needed for my project's APIs?