[WIP] - Enable XRD generation alongside CRDs #230
Draft
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
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.
This commit introduces changes necessary to support XRD to Api docs compilation.
It achieves this by detecting both CRDs and XRDs, which are simply an extended CRD format, and if an XRD is detected, loading both formats; this allows for minimal changes to the code structure whilst still supporting XRDs.
Additional properties are added to the go template attributes fields to support the extended mode.
See the template https://github.com/giantswarm/crossplane-gs-apis/blob/main/doc-gen.config for an example of the fields output.
Checklist