Skip to content

Rename GetControllerManagerConfiguration to Complete for ComponentConfig #1252

Closed
@christopherhein

Description

@christopherhein

I'd like to make a change to pkg/config/config.go which will register as a breaking change, when I was implementing the ComponentConfig DeferredFileLoader I setup a func called GetControllerManagerConfiguration() while this name is factually correct it's quite long and couple be replaced by a simpler sounding name like Complete().

Links:
https://github.com/kubernetes-sigs/controller-runtime/blob/master/pkg/config/config.go#L36
https://github.com/kubernetes-sigs/controller-runtime/blob/master/pkg/manager/manager.go#L419

Changing this would make the calls:

newObj, err := loader.Complete()
// error handling

If I were to implement this the PR Checks specifically the go-apidiff will fail since it's a breaking change. Is there a path around this without adding a new func Complete() and supporting both given that this is an alpha feature and it's fully implemented?

Ref #895

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions