Skip to content

chore: make GENERATED_DIAGRAMS_REPO configurable via env var #23380

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

Open
ebembi-crdb wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: make GENERATED_DIAGRAMS_REPO configurable via env var #23380

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
353bc7e
chore: make GENERATED_DIAGRAMS_REPO configurable via env var
May 21, 2026
09775e2
chore: update defaults to cockroachlabs org
May 25, 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
13 changes: 7 additions & 6 deletions .github/scripts/validate_branch_existence.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
validate_branch_existence.py (EDUENG-614)

For every row in src/current/_data/versions.csv, verifies that the listed
crdb_branch_name exists as a branch in cockroachdb/generated-diagrams.
crdb_branch_name exists as a branch in the generated-diagrams repo
(configurable via GENERATED_DIAGRAMS_REPO env var, default: cockroachdb/generated-diagrams).

Also flags entries where versions.csv still points to an older branch even
though the "natural" release-X.Y branch for that version now exists
Expand Down Expand Up @@ -37,7 +38,7 @@
import urllib.request
from pathlib import Path

GENERATED_DIAGRAMS_REPO = "cockroachdb/generated-diagrams"
GENERATED_DIAGRAMS_REPO = os.environ.get("GENERATED_DIAGRAMS_REPO", "cockroachdb/generated-diagrams")
GITHUB_API_BASE = "https://api.github.com"
VERSIONS_CSV = Path("src/current/_data/versions.csv")

Expand Down Expand Up @@ -119,7 +120,7 @@ def run_checks(rows: list[dict], _exists_fn=None) -> list[dict]:
"branch": branch,
"message": (
f"{version}: crdb_branch_name={branch!r} does not exist "
f"in cockroachdb/generated-diagrams."
f"in {GENERATED_DIAGRAMS_REPO}."
),
})
continue
Expand All @@ -137,7 +138,7 @@ def run_checks(rows: list[dict], _exists_fn=None) -> list[dict]:
"expected": expected,
"message": (
f"{version}: crdb_branch_name={branch!r} but {expected!r} "
f"now exists in cockroachdb/generated-diagrams. "
f"now exists in {GENERATED_DIAGRAMS_REPO}. "
f"Update versions.csv to use {expected!r}."
),
})
Expand All @@ -154,7 +155,7 @@ def format_comment(failures: list[dict]) -> str:
return (
"## Branch Existence Check: Passed\n\n"
"All `crdb_branch_name` entries in `versions.csv` exist in "
"`cockroachdb/generated-diagrams`."
f"`{GENERATED_DIAGRAMS_REPO}`."
)

lines = [
Expand Down Expand Up @@ -225,7 +226,7 @@ def main() -> None:
_run_self_tests()

rows = load_versions_csv()
print(f"Checking {len(rows)} versions.csv entries against cockroachdb/generated-diagrams...\n")
print(f"Checking {len(rows)} versions.csv entries against {GENERATED_DIAGRAMS_REPO}...\n")
failures = run_checks(rows)

comment = format_comment(failures)
Expand Down
Loading