controller-runtime icon indicating copy to clipboard operation
controller-runtime copied to clipboard

✨Move Source definitions to a single folder without breaking the API

Open inteon opened this issue 1 year ago • 2 comments

Moves all the source logic to the same directory, making it easier to understand and refactor in the future.

(1/4) PR chain:

  • https://github.com/kubernetes-sigs/controller-runtime/pull/2685
  • https://github.com/kubernetes-sigs/controller-runtime/pull/2686
  • https://github.com/kubernetes-sigs/controller-runtime/pull/2315
  • https://github.com/kubernetes-sigs/controller-runtime/pull/2159

inteon avatar Feb 13 '24 20:02 inteon

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: inteon Once this PR has been reviewed and has the lgtm label, please assign alvaroaleman for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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 avatar Feb 13 '24 20:02 k8s-ci-robot

@inteon: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-controller-runtime-apidiff 22f4a1507efd3e1e2000af2daab4278937952e14 link false /test pull-controller-runtime-apidiff

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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/test-infra repository. I understand the commands that are listed here.

k8s-ci-robot avatar Apr 22 '24 19:04 k8s-ci-robot

@alvaroaleman could you take a look at this PR too? It should be purely code cleanup/ re-organisation.

inteon avatar Apr 22 '24 19:04 inteon

Moves all the source logic to the same directory, making it easier to understand and refactor in the future.

What is or isn't easier to understand in terms of file layout extremely subjective while not mattering too much in practise due to IDE tooling. At the same time a change like this has a cost in review capacity and in that it breaks git blame. Given that there is no clear benefit but a clear cost I'm -1 to this.

Thanks for the feedback. I updated https://github.com/kubernetes-sigs/controller-runtime/pull/2686 so it does no longer depend on this PR.

inteon avatar Apr 23 '24 08:04 inteon