Peach: Local-first video metadata scraper and media manager.
fix(release): 定版与打标签之前先复查依赖审计
longmeidao27ba169dc1d5
diff --git a/docs/OPERATIONS.md b/docs/OPERATIONS.mdindex 4f9fe084d..a78a282dd 100644--- a/docs/OPERATIONS.md+++ b/docs/OPERATIONS.md@@ -672,6 +672,7 @@ Windows 托盘在取得单实例锁后启动独立监视器。监视器用 Win32- **定版**:在干净的 master 主检出上运行 `python scripts/release_tag.py --bump auto --apply`。它按上一个版本标签到 HEAD 的区间定档(`bump_part_for()`:主题以 `feat` 开头、带破坏性标记 `!`,或 `migrations/` 有新文件时推 minor,其余推 patch;1.0 要手工 `--bump major` 并另立 ADR,见 ADR-0012),写入 `__version__`,并把 `CHANGELOG.md` 的未发布一节定成这个版本号。区间只改了文档、技能和测试时直接拒绝,因为那样打出的包和上一个标签完全相同。`--bump` 只写文件不提交,并打印定版的那一节供人检查;不带 `--apply` 只打印计划。- **发布**:确认之后运行 `python scripts/release_tag.py --ship --apply`,一次完成剩下四步:提交 `src/peach/__init__.py` 与 `CHANGELOG.md`(消息 `chore(release): 版本 <新版本>`)、推送 master、每 30 秒查一次这个提交的 Test 工作流、变绿后创建并推送 annotated tag。默认最多等 30 分钟,用 `--timeout` 修改。不带 `--apply` 只打印步骤。- `--ship` 在动手前检查:不在 master、变更日志缺这一节、标签已被占用、工作区除了那两份定版文件还有别的改动,任何一条成立就拒绝(标签指向发布提交,夹带什么就等于发布什么)。Test 结束不是绿色就立刻停,这时标签还没打。+- 标签流水线第一步就跑仓库根与 `frontend` 两份 npm 审计;新公布的高危漏洞会让已打出的标签什么也发不了。所以 `--bump --apply` 写文件前、`--ship` 在 Test 转绿之后打标签之前,都先用 `scripts/npm_audit.py` 的同一判据复查一次,有高危漏洞就停,版本文件与标签都不动。- 等 Test 期间能确定等不到结果的也立刻停,不耗到超时:GitLab 必需任务(`verify-linux`、`verify-windows`、`verify-macos`、`wheel-smoke`)已失败;任务排着队没人接,且带这些 tags 的 runner 都不在线或已暂停(读 runner 列表要维护者权限;读不到,或列表里查不到带这些 tags 的 runner 时,按排队满 5 分钟仍未开始判停);推送 5 分钟后仍没有 Test 记录。报错写明任务名、tags 和已等时长。GitHub 只对自建 runner 任务做同样判断,托管 runner 排队照常等。处理好之后再跑一次 `--ship --apply` 接着走。- 中途停下(断网、CI 还在跑、超时)就再运行一次同一条命令:每一步都先看当前状态,已提交的不重复提交,已推送的不重复推送,Test 没绿绝不打标签。- 单独补打标签用 `python scripts/release_tag.py`:默认只检查本地与 GitHub master 一致、这个提交最新的 Test 全绿、`CHANGELOG.md` 有这个版本的一节、标签不存在;加 `--apply` 才创建 annotated tag 并只推送这个标签。适用于发布提交已推送、只差标签的情况。变更日志那一节是硬性要求,缺了先用 `--bump` 起草。版本标签不覆盖,下一版先改 `__version__`。推送失败留下本地标签时,先确认归属再人工处理,不强推。Release 工作流会再检查标签提交在 master 历史里、同一提交的 Test 已通过,然后构建、验收制品、创建预发布。打标签代表公开预发布,不等于替换本机生产入口。diff --git a/scripts/release_tag.py b/scripts/release_tag.pyindex ad30fbade..d810d402d 100644--- a/scripts/release_tag.py+++ b/scripts/release_tag.py@@ -218,6 +218,17 @@ def _require_free_tag(repo: str, tag: str) -> None:raise ValueError(f"{tag} 已存在,不覆盖;发布新版本请先推进 __version__")+def require_clean_dependencies(root: Path = None) -> None:+ """标签前复核依赖审计:标签流水线第一件事就是同一套 npm 审计,新公布的高危漏洞+ 会让已经打出去的标签什么也发不出。在打标签之前先查,有漏洞就不定版、不打标签。"""+ from . import npm_audit+ root = root or ROOT+ failed = [str(project.relative_to(root)) or "." for project in (root, root / "frontend")+ if npm_audit.audit(project) != 0]+ if failed:+ raise ValueError("依赖审计发现高危漏洞(" + "、".join(failed) + ");先升级依赖再发布")++def prepare(repo: str, part: str, *, apply: bool,reference_evidence: dict[str, Path] | None = None) -> dict:"""为下一次发布推进版本号并起草变更日志。@@ -232,6 +243,7 @@ def prepare(repo: str, part: str, *, apply: bool,result = {**planned, "tag": tag, "repo": repo, "applied": apply}if not apply:return result+ require_clean_dependencies()from .release_review import reviewoptions = {"public_github": True} if GITLAB else {}if reference_evidence:@@ -305,6 +317,7 @@ def ship(repo: str, *, apply: bool, timeout: float = TEST_TIMEOUT) -> dict:if master_sha(repo) != sha:command("git", "push", remote_url(repo), "refs/heads/master")checked = await_test(repo, sha, timeout=timeout)+ require_clean_dependencies()command("git", "tag", "-a", tag, sha, "-m", f"Peach {tag} Windows 测试版")command("git", "push", remote_url(repo), f"refs/tags/{tag}")return {**result, "sha": sha, "test": checked["html_url"],diff --git a/tests/test_scripts.py b/tests/test_scripts.pyindex f7d985836..302db0f89 100644--- a/tests/test_scripts.py+++ b/tests/test_scripts.py@@ -5414,6 +5414,37 @@ class ReleaseTagTests(unittest.TestCase):@classmethoddef setUpClass(cls):cls.release = load_script("release_tag")+ cls.audit_dependencies = staticmethod(cls.release.require_clean_dependencies)++ def setUp(self):+ # 定版前的依赖审计要联网跑 npm;用例默认它通过,专门的用例单独让它拦下。+ audit = mock.patch.object(self.release, "require_clean_dependencies")+ audit.start()+ self.addCleanup(audit.stop)++ def test_dependency_audit_covers_both_npm_projects_and_names_the_failing_one(self):+ """标签流水线第一步就是这两份 npm 审计;有一份不干净就不能定版或打标签。"""+ root = Path("C:/repo")+ verdicts = {root: 0, root / "frontend": 1}+ with mock.patch("scripts.npm_audit.audit", side_effect=lambda project: verdicts[project]) as audit, \+ self.assertRaisesRegex(ValueError, "frontend"):+ self.audit_dependencies(root)+ self.assertEqual([call.args[0] for call in audit.call_args_list], [root, root / "frontend"])+ with mock.patch("scripts.npm_audit.audit", return_value=0):+ self.audit_dependencies(root)++ def test_a_vulnerable_dependency_keeps_version_files_untouched(self):+ with self._shell(), mock.patch.object(self.release, "api", return_value=[]), \+ mock.patch.object(self.release.version_bump, "plan_bump",+ return_value=self._planned_bump()), \+ mock.patch.object(self.release, "require_clean_dependencies",+ side_effect=ValueError("依赖审计发现高危漏洞(frontend)")), \+ mock.patch.object(self.release.version_bump, "write_version") as write, \+ mock.patch.object(self.release.changelog, "release") as promote, \+ self.assertRaisesRegex(ValueError, "高危漏洞"):+ self.release.prepare("owner/repo", "auto", apply=True)+ write.assert_not_called()+ promote.assert_not_called()def test_latest_matching_master_run_must_finish_successfully(self):success = dict(id=1, head_sha="abc", head_branch="master", event="push",@@ -5650,6 +5681,20 @@ class ShipTests(unittest.TestCase):def setUpClass(cls):cls.release = load_script("release_tag")+ def setUp(self):+ audit = mock.patch.object(self.release, "require_clean_dependencies")+ self.audit = audit.start()+ self.addCleanup(audit.stop)++ def test_a_vulnerable_dependency_found_after_the_test_turns_green_stops_before_the_tag(self):+ """Test 绿了到打标签之间可能刚好公布了新漏洞:标签打出去就什么也发不了,所以标签前再查一次。"""+ self.audit.side_effect = ValueError("依赖审计发现高危漏洞(frontend)")+ with self._shell() as command, self._api(remote="abc"), self._version(), self._document(), \+ self.assertRaisesRegex(ValueError, "高危漏洞"):+ self.release.ship("owner/repo", apply=True)+ self.assertFalse([args for args in self._writes(command) if args[:3] == ("git", "tag", "-a")+ or (args[:2] == ("git", "push") and any("refs/tags/" in part for part in args))])+#: 一次干净的起点:在 master 上,工作区正好是那两份定版文件,本地没有这个标签。SHELL = {("git", "branch", "--show-current"): "master",("git", "status", "--porcelain"): " M CHANGELOG.md\n M src/peach/__init__.py",