Skip to content

Commit

Permalink
Strip comments from CRD descriptions
Browse files Browse the repository at this point in the history
Kubernetes has some conventions for type descriptions:

- Line that only contains --- separates the description from comments.
  The leading lines are part of public documentation, the trailing lines are
  internal instructions such as code examples etc.
- Line that begins with TODO are internal notes for implementers, and not
  part of public documentation of the type.

This change strips above informational text away from the generated CRDs
while keeping them if they appear inside markdown fenced code block.

Signed-off-by: Tero Saarni <tero.saarni@est.tech>
  • Loading branch information
tsaarni committed Jun 17, 2024
1 parent bfff3ce commit 835e054
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 84 deletions.
Loading

0 comments on commit 835e054

Please sign in to comment.