Skip to content

Commit c967dd0

Browse files
Debanitrklclaude
andcommitted
fix: address CodeRabbit review comments
- Escape pipe and newline characters in adopter table cells - Fail fast if ADOPTERS markers are missing or ambiguous in README - Hyphenate "full-stack" compound adjective in README Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent bc1c3f6 commit c967dd0

2 files changed

Lines changed: 11 additions & 5 deletions

File tree

.github/workflows/sync-adopters.yaml

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ jobs:
2323
with open("USERS.md") as f:
2424
lines = f.read().strip().split("\n")
2525
26+
def esc_cell(value: str) -> str:
27+
return value.replace("\n", " ").replace("|", r"\|").strip()
28+
2629
rows = []
2730
for line in lines:
2831
if not line.startswith("|"):
@@ -35,20 +38,23 @@ jobs:
3538
if org == "Organization" or org.startswith("---") or org.startswith("--"):
3639
continue
3740
desc = parts[3]
38-
rows.append(f"| {org} | {desc} |")
41+
rows.append(f"| {esc_cell(org)} | {esc_cell(desc)} |")
3942
4043
table = "| Organization | Description of Use |\n| --- | --- |\n" + "\n".join(rows)
4144
4245
# Replace content between markers in README.md
4346
with open("README.md") as f:
4447
readme = f.read()
4548
46-
readme = re.sub(
49+
pattern = re.compile(
4750
r"(<!-- ADOPTERS:START -->\n).*?(\n<!-- ADOPTERS:END -->)",
48-
rf"\g<1>{table}\g<2>",
49-
readme,
5051
flags=re.DOTALL,
5152
)
53+
readme, replaced = pattern.subn(
54+
rf"\g<1>{table}\g<2>", readme, count=1
55+
)
56+
if replaced != 1:
57+
raise SystemExit("Expected exactly one ADOPTERS block in README.md")
5258
5359
with open("README.md", "w") as f:
5460
f.write(readme)

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
</div>
1919

20-
Parseable is a full stack observability platform built to ingest, analyze and extract insights from all types of telemetry (MELT) data. You can run Parseable on your local machine, in the cloud, or use [Parseable Cloud](https://app.parseable.com) — the fully managed service. To experience Parseable UI, checkout [demo.parseable.com ↗︎](https://demo.parseable.com/login).
20+
Parseable is a full-stack observability platform built to ingest, analyze and extract insights from all types of telemetry (MELT) data. You can run Parseable on your local machine, in the cloud, or use [Parseable Cloud](https://app.parseable.com) — the fully managed service. To experience Parseable UI, checkout [demo.parseable.com ↗︎](https://demo.parseable.com/login).
2121

2222
<div align="center">
2323
<h3>

0 commit comments

Comments
 (0)