Skip to content

chore: refactor generated POLICIES.md #60

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
olblak merged 1 commit into from
Oct 31, 2025
Merged

chore: refactor generated POLICIES.md #60

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
6 changes: 3 additions & 3 deletions .ci/scripts/docgen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ def load_policy_metadata(file_path: str) -> PolicyMetadata:

def generate_markdown_table(policies: List[PolicyMetadata]) -> str:
"""Generate a Markdown table from a list of PolicyMetadata objects."""
header = "| URL | Version | Description | Link |\n"
separator = "|------------|----------|-----------|---------| \n"
header = "| URL | Description | Link |\n"
separator = "|------------|-----------|---------| \n"
rows = []
for p in policies:
description = p.description.replace("\n", " ").strip()
ghcr_path = f"ghcr.io/{os.path.normpath(os.path.dirname(p.path))}"
readme_url = replace_filename_in_url(f"https://github.com/updatecli/policies/tree/main/{p.path}", "README.md")
rows.append(f"| `{ghcr_path or '-'}` | {p.version or '-'} | {description or '-'} | {f"[link]({readme_url})" } |")
rows.append(f"| `{ghcr_path}@{p.version}` | {description or '-'} | {f"[link]({readme_url})" } |")
return header + separator + "\n".join(rows)

def replace_filename_in_url(url: str, new_filename: str) -> str:
Expand Down