|
| 1 | +#!/usr/bin/env python3 |
| 2 | + |
| 3 | +from collections.abc import Mapping |
| 4 | +import pathlib |
| 5 | +import re |
| 6 | +from string import Template |
| 7 | +import sys |
| 8 | +from typing import Iterator, NamedTuple |
| 9 | +from urllib.parse import urljoin, quote |
| 10 | + |
| 11 | + |
| 12 | +TAG_REF_PREFIX = "refs/tags/" |
| 13 | +RE_PORTABLE_RID = re.compile( |
| 14 | + r"[-.]((?:android|ios|iossimulator|linux|linux-bionic|linux-musl|osx|win)-[0-9a-z]+)\.tar(?:\.gz|\.bz2|\.xz|\.zst)?$" |
| 15 | +) |
| 16 | + |
| 17 | +def usage(argv0: str) -> int: |
| 18 | + print( |
| 19 | + f"usage: {argv0} <owner/repo> <{TAG_REF_PREFIX}/RELEASE-TAG-NAME> <path/to/out/dir>", |
| 20 | + file=sys.stderr, |
| 21 | + ) |
| 22 | + return 1 |
| 23 | + |
| 24 | + |
| 25 | +def extract_rid(name: str) -> str: |
| 26 | + if m := RE_PORTABLE_RID.search(name): |
| 27 | + return m.group(1) |
| 28 | + raise ValueError(f"not name of an archive with RID: {name}") |
| 29 | + |
| 30 | + |
| 31 | +class URLMaker: |
| 32 | + def __init__(self, owner_repo: str, release_name: str) -> None: |
| 33 | + release_name = quote(release_name) |
| 34 | + self._base = f"https://github.com/{owner_repo}/releases/download/{release_name}/" |
| 35 | + |
| 36 | + def make_download_url(self, asset_name: str) -> str: |
| 37 | + return urljoin(self._base, quote(asset_name)) |
| 38 | + |
| 39 | + |
| 40 | +class MiscFile(NamedTuple): |
| 41 | + name: str |
| 42 | + desc: str |
| 43 | + |
| 44 | + |
| 45 | +class TemplateCtx(Mapping[str, str]): |
| 46 | + def __init__(self, um: URLMaker) -> None: |
| 47 | + self._um = um |
| 48 | + self._known_rids: dict[str, None] = {} |
| 49 | + self._sdk_archives_by_rid: dict[str, str] = {} |
| 50 | + self._symbols_all_archives_by_rid: dict[str, str] = {} |
| 51 | + self._symbols_sdk_archives_by_rid: dict[str, str] = {} |
| 52 | + self._misc_files: list[MiscFile] = [] |
| 53 | + |
| 54 | + def _note_rid(self, rid: str) -> None: |
| 55 | + self._known_rids[rid] = None |
| 56 | + |
| 57 | + def add_sdk_archive(self, name: str) -> None: |
| 58 | + # name is like "dotnet-sdk-9.0.101-linux-x64.tar.gz" |
| 59 | + rid = extract_rid(name) |
| 60 | + self._note_rid(rid) |
| 61 | + self._sdk_archives_by_rid[rid] = name |
| 62 | + |
| 63 | + def add_symbol_archive(self, name: str) -> None: |
| 64 | + rid = extract_rid(name) |
| 65 | + self._note_rid(rid) |
| 66 | + if name.startswith("dotnet-symbols-all-"): |
| 67 | + self._symbols_all_archives_by_rid[rid] = name |
| 68 | + elif name.startswith("dotnet-symbols-sdk-"): |
| 69 | + self._symbols_sdk_archives_by_rid[rid] = name |
| 70 | + else: |
| 71 | + raise ValueError(f"unexpected symbol archive kind: {name}") |
| 72 | + |
| 73 | + def _add_misc_file(self, f: MiscFile) -> None: |
| 74 | + self._misc_files.append(f) |
| 75 | + |
| 76 | + def add_sb_artifacts_archive(self, name: str) -> None: |
| 77 | + rid = extract_rid(name) |
| 78 | + self._note_rid(rid) |
| 79 | + return self._add_misc_file( |
| 80 | + MiscFile(name, f"源码构建用产物包 / Source-build artifacts - `{rid}`"), |
| 81 | + ) |
| 82 | + |
| 83 | + def add_sdk_feed_archive(self, name: str) -> None: |
| 84 | + if name.startswith("sdk-feed-stage1"): |
| 85 | + return self._add_misc_file( |
| 86 | + MiscFile(name, "更新源用物料 / SDK feed material - `linux-x64`"), |
| 87 | + ) |
| 88 | + elif name.startswith("sdk-feed-stage2"): |
| 89 | + rid = extract_rid(name) |
| 90 | + self._note_rid(rid) |
| 91 | + return self._add_misc_file( |
| 92 | + MiscFile(name, f"更新源用物料 / SDK feed material - `{rid}`"), |
| 93 | + ) |
| 94 | + else: |
| 95 | + raise ValueError(f"unexpected sdk feed archive name: {name}") |
| 96 | + |
| 97 | + def make_row(self, filename: str, desc: str) -> str: |
| 98 | + url = self._um.make_download_url(filename) |
| 99 | + sha256 = self._um.make_download_url(filename + ".sha256") |
| 100 | + sha512 = self._um.make_download_url(filename + ".sha512") |
| 101 | + return f"| [{desc}]({url}) | [SHA256]({sha256}), [SHA512]({sha512}) |\n" |
| 102 | + |
| 103 | + def rid_assets_rows(self, rid: str) -> list[str]: |
| 104 | + result: list[str] = [] |
| 105 | + if f := self._sdk_archives_by_rid.get(rid, None): |
| 106 | + result.append(self.make_row(f, ".NET SDK")) |
| 107 | + if f := self._symbols_all_archives_by_rid.get(rid, None): |
| 108 | + result.append(self.make_row(f, "调试符号 (所有) / Debug symbols (all)")) |
| 109 | + if f := self._symbols_sdk_archives_by_rid.get(rid, None): |
| 110 | + result.append(self.make_row(f, "调试符号 (SDK) / Debug symbols (SDK)")) |
| 111 | + return result |
| 112 | + |
| 113 | + def misc_files_rows(self) -> list[str]: |
| 114 | + return [self.make_row(mf.name, mf.desc) for mf in sorted(self._misc_files)] |
| 115 | + |
| 116 | + def __iter__(self) -> Iterator[str]: |
| 117 | + # "rid_*" and "misc" |
| 118 | + yield from self._known_rids.keys() |
| 119 | + if self._misc_files: |
| 120 | + yield "misc" |
| 121 | + |
| 122 | + def __len__(self) -> int: |
| 123 | + has_misc = len(self._misc_files) > 0 |
| 124 | + return len(self._known_rids) + (1 if has_misc else 0) |
| 125 | + |
| 126 | + def __getitem__(self, k: str) -> str: |
| 127 | + if k.startswith("rid_"): |
| 128 | + rid = k[4:].replace("_","-") |
| 129 | + return "".join(self.rid_assets_rows(rid)) |
| 130 | + elif k == "misc": |
| 131 | + return "".join(self.misc_files_rows()) |
| 132 | + raise KeyError(f"unsupported key: {k}") |
| 133 | + |
| 134 | + |
| 135 | +def main(argv: list[str]) -> int: |
| 136 | + if len(argv) != 4: |
| 137 | + return usage(argv[0]) |
| 138 | + |
| 139 | + if not argv[2].startswith(TAG_REF_PREFIX): |
| 140 | + return usage(argv[0]) |
| 141 | + |
| 142 | + owner_repo = argv[1] # let's just trust the input from CI |
| 143 | + tag_name = argv[2][len(TAG_REF_PREFIX):] |
| 144 | + outdir = pathlib.Path(argv[3]) |
| 145 | + |
| 146 | + um = URLMaker(owner_repo, tag_name) |
| 147 | + tctx = TemplateCtx(um) |
| 148 | + for f in outdir.glob("*"): |
| 149 | + name = f.name |
| 150 | + is_sha256 = name.endswith(".sha256") |
| 151 | + is_sha512 = name.endswith(".sha512") |
| 152 | + if is_sha256 or is_sha512: |
| 153 | + # we assume every archive is accompanied by these, so no need to |
| 154 | + # track individually |
| 155 | + continue |
| 156 | + |
| 157 | + if name.startswith("Private.SourceBuilt.Artifacts."): |
| 158 | + tctx.add_sb_artifacts_archive(name) |
| 159 | + elif name.startswith("dotnet-sdk-"): |
| 160 | + tctx.add_sdk_archive(name) |
| 161 | + elif name.startswith("dotnet-symbols-"): |
| 162 | + tctx.add_symbol_archive(name) |
| 163 | + elif name.startswith("sdk-feed-"): |
| 164 | + tctx.add_sdk_feed_archive(name) |
| 165 | + else: |
| 166 | + print(f"warning: unrecognized asset name {name}", file=sys.stderr) |
| 167 | + |
| 168 | + my_dir = pathlib.Path(__file__).parent |
| 169 | + tmpl_str = (my_dir / '..' / 'templates' / 'release-notes.md').read_text() |
| 170 | + tmpl = Template(tmpl_str) |
| 171 | + print(tmpl.substitute(tctx).strip('\n')) |
| 172 | + |
| 173 | + return 0 |
| 174 | + |
| 175 | + |
| 176 | +if __name__ == "__main__": |
| 177 | + sys.exit(main(sys.argv)) |
0 commit comments