fix: Add Markers and Move Comments for API Docs #1802
Merged
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
Update our code comment markers and copyright notice placement so that the elastic/crd-ref-docs tool can generate API reference docs: - Add `kubebuilder:object:root=true` marker for root CRD types. The crd-ref-docs tool looks for these to identify new `Kind` APIs. - Move copyright comments so they are not mistaken for package-level docs. Note - this only applies to the `v1beta1` API. Signed-off-by: Adam Kaplan <[email protected]>
openshift-ci
bot
added
the
release-note-none
pull-request-size
bot
added
the
size/M
openshift-ci
bot
added
the
kind/cleanup
4 tasks
Comment on lines
-7
to
-9
| // Package v1beta1 contains API Schema definitions for the build v1beta1 API group | ||
| // +k8s:deepcopy-gen=package,register | ||
| // +groupName=shipwright.io |
There was a problem hiding this comment.
I honestly do not fully know what those annotations are for, but as you had not specifically mentioned it, I'd like to make sure this was intentionally removed.
There was a problem hiding this comment.
Yes, this was intentionally removed. The markers are duplicated in doc.go, and I verified that removing this didn't change how the CRDs were generated.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: SaschaSchwarze0 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 |
openshift-ci
bot
added
the
approved
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.
Changes
Update our code comment markers and copyright notice placement so that the elastic/crd-ref-docs tool can generate API reference docs:
kubebuilder:object:root=truemarker for root CRD types. The crd-ref-docs tool looks for these to identify newKindAPIs.Note - this only applies to the
v1beta1API.Needed for shipwright-io/website#147
/kind cleanup
Submitter Checklist
See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.
Release Notes