Tags: elastic/crd-ref-docs
Tags
chore(deps): upgrade sigs.k8s.io/controller-tools to v0.14.0 (#63) This updates sigs.k8s.io/controller-tools to v0.14.0. With this new version the rendering of multi lines and empty lines has changed a little. The asciidoc and markdown renderers are therefore updated to take this into account. --------- Signed-off-by: Justen Stall <[email protected]> Co-authored-by: Amund Tenstad <[email protected]> Co-authored-by: Thibault Richard <[email protected]>
feat: parse markers (#55) This parses all CRD markers so that e.g. `default` and `validation` markers are available to generate the doc. The markers are not used for anything right now, but can be accessed via `{{ $type.Markers }}` and `{{ .Markers }}` in `type.tpl` templates.
Update dependencies (#43) * Update github.com/goccy/go-yaml to `v1.11.0` * Update github.com/spf13/cobra to `v1.7.0` * Update github.com/stretchr/testify to `v1.8.1` * Update go.uber.org/zap to `v1.24.0` * Update golang.org/x/tools to `v0.8.0` * Update k8s.io/apimachinery to `v0.27.1` * Update sigs.k8s.io/controller-tools to `v0.11.4`
Fix processing & linking of alias types (#6) * Fix processing & linking of alias types Prior to this change, alias types would be added to the `processor.Types` map twice, in the case where an API defines both the alias type, and another struct which uses either a pointer to, or an array / slice of, an alias type. Depending on which element is processed first, the alias type would be added to the map as an AliasKind, or a SliceKind/ArrayKind/PointerKind. This means that where templates attempt to render an underlying type of an Alias using `IsAlias`, the alias may be registered as a non-alias type. In addition, alias types were treated as Basic in the renderer if their underlying types were basic. This means in the above case, links are not generated to the alias type in the generated documentation, despite them being a valid type as part of the API. * Add & fix unit test for alias array
PreviousNext