Adding docs using utilruntime.Must for scheme registration #894
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Chris Hein <me@chrishein.com>
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/S
|
/assign @vincepri |
|
/unassign @vincepri |
|
@DirectXMan12 What is best practice using EDIT: nvm. kubernetes-sigs/kubebuilder#1462 (comment) seems to answer this. |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: christopherhein, mengqiy 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:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
thanks @mengqiy! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In addition to adding scaffolded
utilruntime.Mustfor scheme registration inkubebuilder(kubernetes-sigs/kubebuilder#1462) this updates the docs forcontroller-runtimedocs to include panicking when scheme registration fails.You will notice that internal to
localSchemeBuilderinclient-go(https://github.com/kubernetes/client-go/blob/master/kubernetes/scheme/register.go#L133) and most schemes within kubernetes they cause panics if anything from conversions to defaults fail.After discussing with @DirectXMan12 this being left out probably either an oversight to that this pattern was developed after these packages where made.
Signed-off-by: Chris Hein me@chrishein.com