crd-ref-docs

Changelog

• dfa49caa53428ba72adc1e532365d74bc8ab2a81 Add apiextensions types to default Kubernetes known types (#82)
• c0c1522dd71a740498609fc63d358995584b4122 Add output mode in README.md (#77)
• 0ad85c56e5a611240525e8b4a641b9cee33acd9a Also support version on go install (#87)
• 282ebc85bd0afd86b2ff6982b3eed984a141255e Fix missing markdown table formatting (#85)
• 9e0eec84f7f6b24a8113a557ef7e3372472bb4bc Return exit code 1 on failure and silence redundant cobra errors (#86)
• ea9fcaa0230f2ca0f1549c79d70def5f75cd3aa2 Support constant values of enum aliased types (#79)
• 284491a93a220e60bb0d4600ee86e4048afc3514 Support custom markers (#76)
• a178c7be423ad8e34df189bf7b4c05f393f3395b Support multi-arch release (#78)
• 1c93a292ca9b818dbc16083d63c71099983d1edf fix: escape curly brackets when rendering markdown field doc (#81)
• 56876bccac3a39b45314b205e5abdc8e251b5caa fix: escape pipes when rendering validation custom markers to markdown

Changelog

• a7eeb94d685bd662aafd869d24501644a0c25449 Also support version on go install
• b78ab371d7dc70c27133eb266576f7021166eb5a Use latest goreleaser-action@v6

What's Changed

Bug Fixes

• Do not process a type if it is ignored by @barkbay in https://github.com/elastic/crd-ref-docs/pull/73

Enhancements

• Update dependencies by @barkbay in https://github.com/elastic/crd-ref-docs/pull/72
• Go version: s/1.20.x/1.22.x by @barkbay in https://github.com/elastic/crd-ref-docs/pull/74

New Contributors

• @barkbay made their first contribution in https://github.com/elastic/crd-ref-docs/pull/73

Full Changelog: https://github.com/elastic/crd-ref-docs/compare/v0.0.11...v0.0.12

Enhancements

• Support for generating separate files for each API group (by @airycanon #67)

Bug fixes

• Escape asterix in asciidoc rendered (by @tenstad in #64)

Misc

• chore(deps): upgrade sigs.k8s.io/controller-tools to v0.14.0 (by @justenstall in #63), which allows support for go v1.22.
• Test with multiple api packages (by @tenstad in #66)
• Increase default maximum recursion level for type discovery (by @tenstad in #65)
• Update default templates with default and validation markers (by @tenstad in #49)

Enhancements

• Parse CRD default and validation markers (by @tenstad in #55)

Bug fixes

• Handle fields with multi-line comments (by @czeslavo in #53)
• Parse underlying types correctly (by @tenstad in #51)
• Use single parser collector (by @tenstad in #50)
• Assign inline based on json tag (by @tenstad in #48)
• Parse standalone types correctly (by @tenstad in #47)

Misc

• chore: update go mod version to 1.20 (by @tenstad in #46)
• test: update to kubebuilder 3.11.1 and kubernetes 1.25 (by @tenstad in #45)

Contributors

• @czeslavo made their first contribution in https://github.com/elastic/crd-ref-docs/pull/53
• A big thank you to @tenstad who contributed very actively to this release

Enhancements

• Add custom link declaration support for known types (#37)
• Make inlined structs get references from where they are inlined (#33)
• Support multi-line and indent preservation using raw docstring for type docs (#28)
• Support for inlining fields of embedded types (#25)

Misc

• Update go dependencies (#43)
• Update go to 1.20 (#42)
• Run e2e tests on build (#41)
• Enable build action for PR (#40)
• Fix formatting in test types (#32)
• Use test config in tests (#24)

• Update setup-go and checkout actions to v3 (#23)
• Escape pipe characters in field documentation for asciidoc (#17)
• Fix array/slice/pointer type for custom types (#21)
• Add support for Markdown rendering (#16)
• Embed default templates in binary (#15)
• Add CONTRIBUTING.md (#10)

• Do not ignore basic type comments (#8)

• Fix processing & linking of alias types (#6)

• Sort kinds (#4)

• Add config option to exclude GroupVersion (#3)

• Sort references (#2)

• Release candidate (#1)