Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

:recycle: Separate package verification from release builds

Danielfc4f2dd324e9
diff --git a/docs/RELEASE-VERIFICATION.zh-CN.md b/docs/RELEASE-VERIFICATION.zh-CN.md
index c369c0042f..873f1d25e5 100644
--- a/docs/RELEASE-VERIFICATION.zh-CN.md
+++ b/docs/RELEASE-VERIFICATION.zh-CN.md
@@ -138,7 +138,7 @@ python -X utf8 scripts/build-release.py --platforms android --execute
python -X utf8 scripts/build-release.py --platforms harmony --execute
```
-脚本自动构建、复制移动端内核和资源,各平台产物生成后立即收集到桌面 `siyuan` 文件夹,不等待全部平台完成;所有选定平台构建结束后,在桌面目录统一校验,包含目录中已有的安装包。后续平台构建或最终校验失败时,已收集的包仍保留,但不能视为校验通过。Android 官方版命名为 `siyuan-版本号.apk`,例如 `siyuan-3.8.6.apk`。已有同名安装包不会覆盖。脚本不生成或更新 `SHA256SUMS.txt`,也不调用 `checksum.exe`。
+脚本自动构建、复制移动端内核和资源,各平台产物生成后立即收集到桌面 `siyuan` 文件夹,不等待全部平台完成;所有选定平台构建结束后只提示手动校验命令,不自动调用安装包校验器。后续平台构建失败时,已收集的包仍保留;构建成功不代表安装包已校验通过。Android 官方版命名为 `siyuan-版本号.apk`,例如 `siyuan-3.8.6.apk`。已有同名安装包不会覆盖。脚本不生成或更新 `SHA256SUMS.txt`,也不调用 `checksum.exe`。
实际执行时,脚本在主仓库同级的 `release-records/版本号/时间-随机后缀/` 保存本次记录,例如 `D:\88250\release-records\3.8.6\20260929-093000-xxxxxxxx\`。启动和结束时都会打印完整目录,构建失败后也会保留。可用 `--records-dir` 指定记录根目录;记录须与源码仓库、安装包目录及系统临时目录分开。仅预览计划不会创建记录。
@@ -146,9 +146,8 @@ python -X utf8 scripts/build-release.py --platforms harmony --execute
| --- | --- |
| `build.log` | 带时间的脚本输出、构建命令输出和错误信息,同时保留终端显示 |
| `progress.json` | 总体状态、各阶段状态、开始与结束时间、耗时、已收集产物路径、最后执行的命令及失败原因 |
-| `verification.json` | 进入最终校验阶段后生成的安装包检查结果和 SHA256;校验尚未开始时不生成 |
-进度文件在阶段开始、结束、命令执行及产物收集时原子更新,Windows AMD64 和 ARM64 分别记录。状态为 `pending`(未开始)、`running`(进行中)、`succeeded`(完成)、`failed`(失败)或 `interrupted`(收到中断)。平台阶段完成仅表示构建和收集完成,全部检查结果以最终校验为准。按 Ctrl+C 时记录中断状态;进程被强制结束或机器断电时,文件可能停留在 `running`,不能据此认为仍在运行。当前记录用于查看和排查,不自动续跑或复用产物。
+进度文件在阶段开始、结束、命令执行及产物收集时原子更新,Windows AMD64 和 ARM64 分别记录。状态为 `pending`(未开始)、`running`(进行中)、`succeeded`(完成)、`failed`(失败)或 `interrupted`(收到中断)。总体及平台阶段完成仅表示构建和收集完成,不包含安装包校验阶段,也不自动生成校验报告;需要报告时,单独运行 `verify-release.py check` 并指定 `--report`。按 Ctrl+C 时记录中断状态;进程被强制结束或机器断电时,文件可能停留在 `running`,不能据此认为仍在运行。当前记录用于查看和排查,不自动续跑或复用产物。
SSH 拉取保留直接终端交互,不采集认证命令的终端输出或键盘输入;日志记录命令和退出结果。内部查询命令的返回内容不直接写入日志,也不保存环境变量、私钥口令或 YubiKey PIN。
@@ -305,10 +304,10 @@ python -X utf8 scripts/verify-release.py check D:/releases/siyuan --version 3.8.
- 脚本检查内核 `Ver`、`Mode`、Android、鸿蒙版本,以及启用 Appx 时的清单版本,不自动修改版本号或 `versionCode`
- `--platforms` 接受逗号分隔的平台名称,可选 `windows`、`linux`、`android`、`harmony`;默认构建四个平台,Appx 需额外指定 `--appx`
- `--output` 可指定产物收集目录,默认桌面 `siyuan`;脚本不覆盖已有同名安装包
-- `--records-dir` 可指定持久化记录根目录,默认主仓库同级 `release-records`;每次执行创建独立目录,保存日志、阶段进度和最终校验报告,清理发布产物时保留
+- `--records-dir` 可指定持久化记录根目录,默认主仓库同级 `release-records`;每次执行创建独立目录,保存日志和阶段进度,清理发布产物时保留
- 脚本保留现有 Android 与鸿蒙签名配置,不读取或输出这些配置里的密码
- WSL 默认用户 `d`、仓库 `/home/d/88250/siyuan`,可通过 `--wsl-user`、`--wsl-repo`、`--wsl-distro` 调整;Linux 或鸿蒙构建预检时自动同步到 Windows 的确切提交,受检查的构建输入须一致,自动同步条件见步骤 2
-- Android、鸿蒙仓库默认在思源仓库同级,可用 `--android-dir`、`--harmony-dir` 调整;工具路径可用 `--arm64-cc`、`--deveco`、`--sevenzip` 调整
+- Android、鸿蒙仓库默认在思源仓库同级,可用 `--android-dir`、`--harmony-dir` 调整;构建工具路径可用 `--arm64-cc`、`--deveco` 调整;`--sevenzip` 仅传入完成后提示的手动校验命令,构建时不检查或调用该工具
### 流程
@@ -319,7 +318,7 @@ python -X utf8 scripts/verify-release.py check D:/releases/siyuan --version 3.8.
- 鸿蒙先构建并复制 ARM64 内核,再构建并复制 x86_64 内核,避免同名 `libkernel.so` 被覆盖后拷错;使用同一份新 `app.zip`,通过 Hvigor release 模式执行 `assembleApp`,对应 DevEco Studio 的“构建 - 编译 Hap(s)/APP(s) - 编译 APP(s)”,只收集 `build/outputs/default/siyuan-harmony-default-signed.app`,缺少签名产物时失败,不收集 `unsigned.app` 或单独的 HAP
- 每条命令失败立即停止,产物必须是本次生成,复制时再次核对摘要
- 鸿蒙各架构的 `entry/libs/<ABI>/` 只接收 `libkernel.so`,头文件仅从 ARM64 构建目录同步到 `entry/src/main/cpp/include/`;`libkernel.h` 必须为本次生成,`lan_sync_bridge.h` 若由构建目录提供则同步,否则保留工程中维护的版本,缺少必需头文件时停止构建
-- 各平台产物生成后立即复制到桌面 `siyuan`,不覆盖同名包;最后统一检查桌面目录,失败时保留已复制的包。需要重新构建同名包时,先人工移走旧包;校验失败修复后可直接对桌面目录重跑 `verify-release.py check`。保留已有的 `SHA256SUMS.txt`,校验和清单由发布者最终手动生成
+- 各平台产物生成后立即复制到桌面 `siyuan`,不覆盖同名包;构建完成后单独运行 `verify-release.py check` 检查收集目录,构建失败时保留已复制的包。需要重新构建同名包时,先人工移走旧包;校验失败修复后可直接对桌面目录重跑 `verify-release.py check`。保留已有的 `SHA256SUMS.txt`,校验和清单由发布者最终手动生成
- 构建目录保留在系统临时目录,控制台打印实际路径,失败后可检查并取回产物;不会自动提交、推送、打标签、上传或发布公告
### YubiKey PIN
diff --git a/scripts/build-release.py b/scripts/build-release.py
index efff2d0715..588b8bd793 100644
--- a/scripts/build-release.py
+++ b/scripts/build-release.py
@@ -55,7 +55,6 @@ class LoggedStream:
class BuildRecord:
def __init__(self, directory, args, version):
self.directory = Path(directory)
- self.report = self.directory / "verification.json"
self.log = None
self.line_start = True
self.active_stage = None
@@ -69,7 +68,6 @@ class BuildRecord:
("windows_arm64", "Windows ARM64")))
stages.extend((platform, {"linux": "Linux", "android": "Android", "harmony": "鸿蒙"}[platform])
for platform in PLATFORMS[1:] if platform in args.platforms)
- stages.append(("verification", "安装包校验"))
self.data = {"schema_version": 1, "version": version, "platforms": args.platforms, "appx": args.appx,
"output_directory": str(args.output), "work_directory": None, "status": "pending",
"current_stage": None, "stages": [dict(id=key, name=name, status="pending", artifacts=[])
@@ -310,8 +308,6 @@ def source_preflight(args, version):
for filename in ("AppxManifest.xml", "AppxManifest-arm64.xml"):
check_version((ROOT / "app/appx" / filename).read_text(encoding="utf-8"),
r'\bVersion="([^"]+)"', version.split("-")[0] + ".0", filename)
- if not VERIFY.find_7z(args.sevenzip):
- raise BuildError("最终安装包验证需要 7-Zip,请安装或指定 --sevenzip")
commands = {"git"}
if set(args.platforms) & {"windows", "android", "harmony"}:
commands.update(("node", "pnpm"))
@@ -582,19 +578,12 @@ class Builder:
self.collect([app], "鸿蒙", started)
def finish(self):
- args = argparse.Namespace(directory=self.args.output, version=self.version, baseline=None,
- report=self.record.report if self.record else None, sevenzip=self.args.sevenzip)
- try:
- failed = VERIFY.verify(args)
- except (VERIFY.VerificationError, OSError, ValueError, subprocess.SubprocessError) as error:
- if args.report and not args.report.exists():
- args.report.write_text(json.dumps({"version": self.version, "directory": str(args.directory),
- "status": "FAIL", "error": str(error), "packages": []},
- ensure_ascii=False, indent=2) + "\n", encoding="utf-8")
- raise
- if failed:
- raise BuildError(f"安装包校验未通过,已收集的产物保留在 {self.args.output}")
- print(f"完成:本次收集 {len(self.artifacts)} 个安装包,{self.args.output} 中的安装包已全部校验")
+ print(f"构建完成:本次收集 {len(self.artifacts)} 个安装包到 {self.args.output};请单独执行安装包校验")
+ command = ["python", "-X", "utf8", "scripts/verify-release.py", "check", str(self.args.output),
+ "--version", self.version]
+ if self.args.sevenzip:
+ command.extend(("--sevenzip", self.args.sevenzip))
+ print(subprocess.list2cmdline(command))
def parser():
@@ -614,7 +603,7 @@ def parser():
result.add_argument("--android-dir", type=Path, default=ROOT.parent / "siyuan-android")
result.add_argument("--harmony-dir", type=Path, default=ROOT.parent / "siyuan-harmony")
result.add_argument("--deveco", type=Path, default=Path("D:/Program Files/Huawei/DevEco Studio"))
- result.add_argument("--sevenzip", help="安装包校验使用的 7-Zip 可执行文件")
+ result.add_argument("--sevenzip", help="仅用于完成后提示的手动校验命令,不在构建时调用")
return result
@@ -645,7 +634,7 @@ def main():
print("构建前自动同步 WSL 到 Windows 当前提交;提交不同时要求两端工作区干净,目标已推送且包含 WSL 当前提交")
for platform in args.platforms:
print(f" {platform}: {descriptions[platform]}")
- print("各平台产物生成后立即复制到收集目录,最后统一校验该目录中的安装包")
+ print("各平台产物生成后立即复制到收集目录,构建完成后请单独执行安装包校验")
if not args.execute:
print("当前仅显示计划,没有执行构建或修改文件;添加 --execute 开始")
return 0
@@ -681,8 +670,7 @@ def execute_build(args, version, record):
method = getattr(builder, platform)
with record.stage(platform) if platform != "windows" else nullcontext():
method(assets) if platform in {"android", "harmony"} else method()
- with record.stage("verification"):
- builder.finish()
+ builder.finish()
if __name__ == "__main__":
diff --git a/scripts/test_build_release.py b/scripts/test_build_release.py
index f2580a2149..e43f6713c1 100644
--- a/scripts/test_build_release.py
+++ b/scripts/test_build_release.py
@@ -295,14 +295,16 @@ class BuildTests(unittest.TestCase):
"siyuan-3.8.4-googleplay-release.aab", "siyuan-3.8.4-huawei-release.aab",
})
- def test_failed_validation_preserves_collected_packages(self):
+ def test_finish_only_prints_manual_validation_command(self):
artifact = self.write(self.builder.work / "bad.apk")
self.builder.collect([artifact], "Android", time.time())
- with patch.object(build.VERIFY, "verify", return_value=1) as verify:
- with self.assertRaises(build.BuildError), contextlib.redirect_stdout(io.StringIO()):
- self.builder.finish()
+ output = io.StringIO()
+ with patch.object(build.VERIFY, "verify") as verify, contextlib.redirect_stdout(output):
+ self.builder.finish()
self.assertEqual((self.args.output / "bad.apk").read_bytes(), artifact.read_bytes())
- self.assertEqual(verify.call_args.args[0].directory, self.args.output)
+ verify.assert_not_called()
+ self.assertIn("scripts/verify-release.py check", output.getvalue())
+ self.assertIn("--version 3.8.4", output.getvalue())
def test_add_platform_preserves_existing_packages_and_checksums(self):
existing = self.write(self.args.output / "siyuan-3.8.4-win.exe", b"signed windows")
@@ -484,10 +486,10 @@ class RecordTests(unittest.TestCase):
self.assertEqual(stages["windows_amd64"]["artifacts"], [str(self.args.output / "windows.exe")])
self.assertEqual(stages["windows_arm64"]["status"], "failed")
self.assertEqual(stages["linux"]["status"], "pending")
- self.assertEqual(stages["verification"]["status"], "pending")
+ self.assertNotIn("verification", stages)
linux.assert_not_called()
- def test_complete_execution_persists_report_and_all_stage_results(self):
+ def test_complete_execution_persists_progress_without_validation(self):
def windows_arch(builder, arch, config):
package = builder.work / f"siyuan-3.8.4-win-{arch}.exe"
package.write_bytes(b"package")
@@ -502,13 +504,15 @@ class RecordTests(unittest.TestCase):
patch.object(build.Builder, "preflight"), patch.object(build.Builder, "build_ui"), \
patch.object(build.Builder, "windows_tools"), \
patch.object(build.Builder, "windows_arch", windows_arch), patch.object(build.Builder, "linux", linux), \
- patch.object(build.VERIFY, "verify_package", return_value={"target": "test", "resource_count": 1}):
+ patch.object(build.VERIFY, "verify") as verify:
with self.record.session():
build.execute_build(self.args, "3.8.4", self.record)
progress = self.progress()
self.assertEqual(progress["status"], "succeeded")
self.assertTrue(all(stage["status"] == "succeeded" for stage in progress["stages"]))
- self.assertEqual(len(json.loads(self.record.report.read_text(encoding="utf-8"))["packages"]), 3)
+ verify.assert_not_called()
+ self.assertFalse((self.directory / "verification.json").exists())
+ self.assertNotIn("verification", [stage["id"] for stage in progress["stages"]])
self.assertFalse((self.args.output / "build.log").exists())
self.assertFalse((self.args.output / "progress.json").exists())
@@ -521,38 +525,8 @@ class RecordTests(unittest.TestCase):
self.assertEqual(self.progress()["status"], "failed")
self.assertEqual(self.progress()["stages"][0]["error"], "missing tool")
self.assertIsNone(self.progress()["work_directory"])
- self.assertFalse(self.record.report.exists())
+ self.assertFalse((self.directory / "verification.json").exists())
ui.assert_not_called()
- def test_verification_report_is_written_on_success_and_failure(self):
- self.args.output.mkdir()
- package = self.args.output / "siyuan-3.8.4-linux.AppImage"
- package.write_bytes(b"package")
- for failure in (False, True):
- record = build.BuildRecord(self.directory, self.args, "3.8.4")
- builder = build.Builder(self.args, "3.8.4", self.root, record)
- effect = build.VERIFY.VerificationError("invalid package") if failure else None
- with patch.object(build.VERIFY, "verify_package", side_effect=effect,
- return_value={"target": "ELF/amd64", "resource_count": 1}), \
- contextlib.redirect_stdout(io.StringIO()):
- if failure:
- with self.assertRaises(build.BuildError):
- builder.finish()
- else:
- builder.finish()
- report = json.loads(record.report.read_text(encoding="utf-8"))
- self.assertEqual(report["packages"][0]["status"], "FAIL" if failure else "PASS")
- self.assertEqual(report["packages"][0]["sha256"], build.VERIFY.digest(package))
- record.report.unlink()
-
- def test_verification_startup_failure_is_reported(self):
- builder = build.Builder(self.args, "3.8.4", self.root, self.record)
- with self.assertRaises(build.VERIFY.VerificationError):
- builder.finish()
- report = json.loads(self.record.report.read_text(encoding="utf-8"))
- self.assertEqual(report["status"], "FAIL")
- self.assertIn("error", report)
-
-
if __name__ == "__main__":
unittest.main()