add support for kubebuilder v2 kubebuilder:object:root comment#26
Open
M00nF1sh wants to merge 1 commit intoahmetb:masterfrom
Open
add support for kubebuilder v2 kubebuilder:object:root comment#26M00nF1sh wants to merge 1 commit intoahmetb:masterfrom
kubebuilder:object:root comment#26M00nF1sh wants to merge 1 commit intoahmetb:masterfrom
Conversation
|
@fawadkhaliq @M00nF1sh I tried your branch on my kuberbuilder api but it's not working |
Owner
|
Thank you. We also need to make sure this doesn't break compat for existing projects (listed in readme). |
Author
@evalsocket, u still need to create a doc.go contain same content(without import and var) of your |
yindia
approved these changes
Jul 17, 2020
Owner
|
@evalsocket Can you also please validate this with one of the projects listed in README.md? Sadly, I can't just merge this because "it works for you". Removing Right now to me, my priorities aren't at Kubebuilder v2 or Operator SDK. This project has existing users and keeping those working is my top priority. |
ironcladlou
added a commit
to ironcladlou/hypershift
that referenced
this pull request
Nov 10, 2021
This commit updates API documentation on the Go types and also improves the generated API documentation to include only the public types, as well as other minor small fixes for readability. Note that the `+gencopy` comments added to the API types are to work around an issue[1] in the upstream docs generation code which doesn't yet understand the `+kubebuilder:object:root` tag. This is necessary to make the generator understand which types are "public" (e.g. HostedCluster and NodePool). [1] ahmetb/gen-crd-api-reference-docs#26
ironcladlou
added a commit
to ironcladlou/hypershift
that referenced
this pull request
Nov 10, 2021
This commit updates API documentation on the Go types and also improves the generated API documentation to include only the public types, as well as other minor small fixes for readability. Note that the `+gencopy` comments added to the API types are to work around an issue[1] in the upstream docs generation code which doesn't yet understand the `+kubebuilder:object:root` tag. This is necessary to make the generator understand which types are "public" (e.g. HostedCluster and NodePool). [1] ahmetb/gen-crd-api-reference-docs#26
ironcladlou
added a commit
to ironcladlou/hypershift
that referenced
this pull request
Nov 10, 2021
This commit updates API documentation on the Go types and also improves the generated API documentation to include only the public types, as well as other minor small fixes for readability. Note that the `+gencopy` comments added to the API types are to work around an issue[1] in the upstream docs generation code which doesn't yet understand the `+kubebuilder:object:root` tag. This is necessary to make the generator understand which types are "public" (e.g. HostedCluster and NodePool). [1] ahmetb/gen-crd-api-reference-docs#26
ironcladlou
added a commit
to ironcladlou/hypershift
that referenced
this pull request
Nov 10, 2021
This commit updates API documentation on the Go types and also improves the generated API documentation to include only the public types, as well as other minor small fixes for readability. Note that the `+gencopy` comments added to the API types are to work around an issue[1] in the upstream docs generation code which doesn't yet understand the `+kubebuilder:object:root` tag. This is necessary to make the generator understand which types are "public" (e.g. HostedCluster and NodePool). [1] ahmetb/gen-crd-api-reference-docs#26
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
The kubebuilder V2 adds
+kubebuilder:object:rootcomment instead of+genclientcomment to public types.BTW, the
+kubebuilder:object:rootis in ListTypes, while+genclientdon't appear in ListTypes, this PR will filter out listTypes if only+kubebuilder:object:rootpresents.