|
| 1 | +"""Build a catalog for published artifacts.""" |
| 2 | + |
| 3 | +# /// script |
| 4 | +# requires-python = ">=3.12" |
| 5 | +# dependencies = [ |
| 6 | +# "packaging", |
| 7 | +# ] |
| 8 | +# /// |
| 9 | + |
| 10 | +import json |
| 11 | +import re |
| 12 | +from os import getenv |
| 13 | +from pathlib import Path |
| 14 | +from subprocess import run |
| 15 | +from typing import Literal |
| 16 | + |
| 17 | +from packaging.version import Version |
| 18 | + |
| 19 | +URL_PREFIX = ( |
| 20 | + f"{getenv('GITHUB_SERVER_URL', default='https://github.com')}" |
| 21 | + f"/{getenv('GITHUB_REPOSITORY', default='typst-community/dev-builds')}" |
| 22 | + "/releases/tag/" |
| 23 | +) |
| 24 | + |
| 25 | +TAG_PATTERN = re.compile( |
| 26 | + r"(?P<artifact>[-a-z]+)-(?P<revision>v[-.0-9rc]+|main\.\d{4}-\d{2}-\d{2}\.[0-9a-f]{6,})" |
| 27 | +) |
| 28 | + |
| 29 | +type RawReleaseMeta = Literal["name", "tagName", "publishedAt"] |
| 30 | +type ReleaseMeta = Literal[ |
| 31 | + "name", "publishedAt", "revision", "releaseTag", "releaseUrl" |
| 32 | +] |
| 33 | + |
| 34 | + |
| 35 | +def get_raw_releases() -> list[dict[RawReleaseMeta, str]]: |
| 36 | + result = run( |
| 37 | + ["gh", "release", "list", "--json", "name,tagName,publishedAt"], |
| 38 | + check=True, |
| 39 | + capture_output=True, |
| 40 | + text=True, |
| 41 | + ) |
| 42 | + return json.loads(result.stdout) |
| 43 | + |
| 44 | + |
| 45 | +def generate_catalog( |
| 46 | + raw_releases: list[dict[RawReleaseMeta, str]], |
| 47 | +) -> dict[str, list[dict[ReleaseMeta, str]]]: |
| 48 | + catalog: dict[str, list[dict[ReleaseMeta, str]]] = { |
| 49 | + # Specify the order of artifacts |
| 50 | + "docs": [], |
| 51 | + "typst": [], |
| 52 | + "package-check": [], |
| 53 | + "hayagriva": [], |
| 54 | + } |
| 55 | + |
| 56 | + for r in raw_releases: |
| 57 | + m = TAG_PATTERN.fullmatch(r["tagName"]) |
| 58 | + assert m is not None, f"failed to parse “{r['tagName']}”" |
| 59 | + match = m.groupdict() |
| 60 | + |
| 61 | + release: dict[ReleaseMeta, str] = { |
| 62 | + "name": r["name"], |
| 63 | + "publishedAt": r["publishedAt"], |
| 64 | + "revision": match["revision"], |
| 65 | + "releaseTag": r["tagName"], |
| 66 | + "releaseUrl": f"{URL_PREFIX}{r['tagName']}", |
| 67 | + } |
| 68 | + |
| 69 | + catalog[match["artifact"]].append(release) |
| 70 | + |
| 71 | + for v in catalog.values(): |
| 72 | + v.sort(key=key_for_release, reverse=True) |
| 73 | + |
| 74 | + return catalog |
| 75 | + |
| 76 | + |
| 77 | +def key_for_release(it: dict[ReleaseMeta, str]) -> tuple[int | str | Version, ...]: |
| 78 | + if it["revision"].startswith("v"): |
| 79 | + version = Version(it["revision"]) |
| 80 | + return 1, version |
| 81 | + else: |
| 82 | + return 0, it["revision"], it["publishedAt"] |
| 83 | + |
| 84 | + |
| 85 | +if __name__ == "__main__": |
| 86 | + root_dir = Path(__file__).parent.parent |
| 87 | + dist_dir = root_dir / "dist" |
| 88 | + dist_dir.mkdir(exist_ok=True) |
| 89 | + |
| 90 | + raw_releases = get_raw_releases() |
| 91 | + catalog = generate_catalog(raw_releases) |
| 92 | + |
| 93 | + catalog_json = json.dumps( |
| 94 | + { |
| 95 | + "version": "0.1.0", |
| 96 | + "artifacts": catalog, |
| 97 | + }, |
| 98 | + indent=2, |
| 99 | + ensure_ascii=False, |
| 100 | + ) |
| 101 | + (dist_dir / "catalog.json").write_text(catalog_json, encoding="utf-8") |
| 102 | + |
| 103 | + run( |
| 104 | + [ |
| 105 | + "typst", |
| 106 | + "compile", |
| 107 | + root_dir / "scripts/catalog.typ", |
| 108 | + dist_dir / "index.html", |
| 109 | + "--features=html", |
| 110 | + f"--root={root_dir}", |
| 111 | + ], |
| 112 | + check=True, |
| 113 | + ) |
0 commit comments