add support for kubebuilder v2 kubebuilder:object:root comment
#26
Conversation
|
@fawadkhaliq @M00nF1sh I tried your branch on my kuberbuilder api but it's not working |
|
Thank you. We also need to make sure this doesn't break compat for existing projects (listed in readme). |
@evalsocket, u still need to create a doc.go contain same content(without import and var) of your |
|
@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. |
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 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 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 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
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.