Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename GetControllerManagerConfiguration to Complete for ComponentConfig #1252

Closed
christopherhein opened this issue Nov 7, 2020 · 4 comments · Fixed by #1253
Closed

Rename GetControllerManagerConfiguration to Complete for ComponentConfig #1252

christopherhein opened this issue Nov 7, 2020 · 4 comments · Fixed by #1253
Assignees

Comments

@christopherhein
Copy link
Member

christopherhein commented Nov 7, 2020

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

@christopherhein
Copy link
Member Author

/cc @DirectXMan12 @vincepri wdyt?

@vincepri
Copy link
Member

vincepri commented Nov 7, 2020

This is fine, the go-apidiff bot checks the diff from the last commit, not the last released version. Given that we haven't released v0.7.0 yet, breaking changes are ok for now. Usually though, we'd hold breaking changes to the next minor release

@christopherhein
Copy link
Member Author

Thanks @vincepri ! I'm going to rename this and put in a PR to rename that then.

@christopherhein
Copy link
Member Author

/assign

@christopherhein christopherhein changed the title ❓ about breaking an alpha Go APIDiff function Rename GetControllerManagerConfiguration to Complete for ComponentConfig Nov 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants