Skip to content

HDDS-14736. Fix the {...} issue in xml_to_md.py and rename appendix.md. #9846

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
adoroszlai merged 2 commits into from
Feb 28, 2026
+7 −3
Merged

HDDS-14736. Fix the {...} issue in xml_to_md.py and rename appendix.md. #9846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19262e7
HDDS-14736. Fix the {...} issue in xml_to_md.py and rename appendix.md.
sarvekshayr Feb 28, 2026
885f745
re.compile the pattern before the loop
sarvekshayr Feb 28, 2026
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
2 changes: 1 addition & 1 deletion .github/workflows/update-ozone-site-config-doc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ jobs:
exit 0
fi

TARGET_FILE="$TARGET_DIR/05-appendix.md"
TARGET_FILE="$TARGET_DIR/99-appendix.md"
echo "Checking against $TARGET_FILE"

# Copy new file to target location
Expand Down
8 changes: 6 additions & 2 deletions dev-support/ci/xml_to_md.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,14 @@ def generate_markdown(properties):
|:-----|:--------------|:-----|:------------|
"""

placeholder_pattern = re.compile(r'(\$)?\{([^}]+)\}')

for prop in sorted(properties.values(), key=lambda p: p.name):
# Escape pipe characters in description to prevent breaking the table
# Escape pipe characters and wrap {placeholders} in backticks
description = prop.description.replace('|', '\\|')
value = prop.value if prop.value else ''
description = placeholder_pattern.sub(r'`\1{\2}`', description)
value = prop.value.replace('|', '\\|') if prop.value else ''
value = placeholder_pattern.sub(r'`\1{\2}`', value) if value else ''

markdown += f"| `{prop.name}` | {value} | {prop.tag} | {description} |\n"

Expand Down