Skip to content

Add support to parse Helm Template artifacts in CRD yaml #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 25, 2025
Merged

Add support to parse Helm Template artifacts in CRD yaml #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions cmd/gen-api-docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,27 @@ def parse_go_file(file_path, go_files, parsed_types=None):

def parse_crd_file(file_path):
with open(file_path, 'r') as f:
try:
crd = yaml.safe_load(f)
except yaml.YAMLError as e:
print(f"Error parsing YAML file {file_path}: {e}")
return None
content = f.read()

# Filter out Helm template syntax before parsing YAML
# Remove Helm template blocks like {{- if .Values.manageCRDs }}, {{ .Values.something }}, etc.
import re
# Remove Helm template conditionals and loops
content = re.sub(r'\{\{-?\s*if\s+[^}]+\s*-?\}\}', '', content)
content = re.sub(r'\{\{-?\s*else\s*-?\}\}', '', content)
content = re.sub(r'\{\{-?\s*end\s*-?\}\}', '', content)
content = re.sub(r'\{\{-?\s*range\s+[^}]+\s*-?\}\}', '', content)
content = re.sub(r'\{\{-?\s*with\s+[^}]+\s*-?\}\}', '', content)
# Remove Helm template variables like {{ .Values.something }}
content = re.sub(r'\{\{-?[^}]+-?\}\}', '', content)
# Remove lines that are only whitespace after template removal
content = '\n'.join(line for line in content.split('\n') if line.strip())

try:
crd = yaml.safe_load(content)
except yaml.YAMLError as e:
print(f"Error parsing YAML file {file_path}: {e}")
return None
if not crd or crd.get('kind') != 'CustomResourceDefinition':
return None

Expand Down