Skip to content

[WIP] - Enable XRD generation alongside CRDs#230

Draft
mproffitt wants to merge 1 commit intomainfrom
enable-xrd
Draft

[WIP] - Enable XRD generation alongside CRDs#230
mproffitt wants to merge 1 commit intomainfrom
enable-xrd

Conversation

@mproffitt
Copy link

@mproffitt mproffitt commented Jul 22, 2024

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

  • Update changelog in CHANGELOG.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments