feat(pkg): 每版本出包替代 git 依赖(release.sh + 文档同步)

- 新增 scripts/release.sh:读 crates/sspf 版本 → 编译预编译 sspf-admin 二进制
  → 组装自包含发布包 dist/sspf-vX.Y.Z.tar.gz(预编译二进制 + 平台 crate 闭包
  + Cargo.lock + rust-toolchain.toml + 前端源码),并自检验证离线可编。
- docs/SSPF-PLATFORM-PACKAGE.md §6 改为「每版本出包、消费方 path 依赖」模型,
  废弃原 git tag 依赖写法;README/HANDOFF/CHANGELOG 同步。
- .gitignore 忽略 dist/
This commit is contained in:
admin committed 2026-11-05 09:28:47 +08:00
1 parent 60af816ded
commit f6c3ff64ee
6 files changed
+303 -17

No files matched your search

+221
View File
@@ -0,0 +1,221 @@
#!/usr/bin/env bash
#
# release.sh —— 给「技能 / 业务」消费方打「自包含发布包」
#
# 为什么要有它(2026-11-05 定的依赖模型变更):
# 消费方(技能仓 `~/.agents/skills/ssw-jnpf-lite-rust`、未来的业务仓 `tdc-rs`)
# **不再**直接依赖本 git 仓、不再每次构建都 clone 整个 monorepo 并重新编译 20+ 个
# 本地 crate。改由本脚本每个版本产出一个**自包含包** `dist/sspf-vX.Y.Z.tar.gz`,
# 消费方把它解包到 `vendor/`,用 `path` 依赖指进去即可。
#
# 包的构成(自包含,消费方 `--offline` 也能编译):
# sspf-vX.Y.Z/
# ├── bin/sspf-admin # 🔴 预编译二进制(字面,平台侧已 release 编译)
# ├── crates/<17 个 sspf-* 闭包> # 🔴 平台 crate 自包含源码(path 依赖吃这层)
# ├── src/backend/ # 🔴 内核 lib(ssw-platform)—— sspf 的 path 依赖
# ├── frontend/ # 平台前端源码(不含 node_modules/dist,可选随包)
# ├── Cargo.toml # 🔴 workspace 根(继承 version/edition 靠它)
# ├── Cargo.lock # 🔴 锁定整个闭包,消费方 --offline 才解析得开
# ├── rust-toolchain.toml # 工具链版本(信息性;消费方需自带同名文件)
# ├── docs/SSPF-PLATFORM-PACKAGE.md # 消费方式说明
# └── README.md # 本包的自述
#
# ⚠️ Rust 库硬约束(务必理解,否则会以为「完全不编译平台」能做到):
# 带类型的库 crate(如 sspf,消费方要 `use sspf::Platform`)**没法被「纯预编译 rlib」
# 当依赖吃**—— Cargo 原生不支持消费预编译 rlib,且 `use sspf::*` 需要接口元数据(.rmeta)。
# 所以「消费方完全不编译平台库」在 Rust 现状下**做不到**。本包的形态是:
# 「预编译的 sspf-admin 二进制(字面)+ 平台 crate 的自包含源码 + Cargo.lock」,
# 消费方依赖包内**源码路径**——仍会编译一次平台库(Rust 库常态),但**不再碰 git、
# 不再 clone 整个 monorepo、不再每次重编 20+ crate**。预编译二进制留给「直接跑平台」模式。
#
# 用法:
# bash scripts/release.sh # 以 crates/sspf 的 version 为版本号出包
# bash scripts/release.sh 0.5.1 # 显式指定版本(覆盖 crates/sspf 的 version)
#
set -euo pipefail
# 切到仓库根(无论从哪里调用)
cd "$(dirname "$0")/.."
REPO_ROOT="$(pwd)"
# ── 1. 决定版本号 ──────────────────────────────────────────────
if [[ $# -ge 1 ]]; then
VERSION="$1"
else
VERSION="$(python3 - <<'PY'
import re,os
p=os.path.join("crates","sspf","Cargo.toml")
t=open(p).read()
m=re.search(r'^version\s*=\s*"([^"]+)"', t, re.M)
print(m.group(1))
PY
)"
fi
# 🔴 目录/包名带 v 前缀,与 git tag(vX.Y.Z)对齐;crate 自身 version 是无 v 的 X.Y.Z
PKG="sspf-v${VERSION}"
DIST_DIR="dist"
PKG_DIR="${DIST_DIR}/${PKG}"
echo "==> 出包版本: ${VERSION}"
echo "==> 目标目录: ${PKG_DIR}"
# ── 2. 编译预编译二进制 sspf-admin(平台侧 release 构建)──────────
echo "==> cargo build --release -p sspf-admin"
cargo build --release -p sspf-admin
BIN="target/release/sspf-admin"
if [[ ! -x "${BIN}" ]]; then
echo "!! 找不到预编译二进制: ${BIN}" >&2
exit 1
fi
# ── 3. 组装目录 ────────────────────────────────────────────────
rm -rf "${PKG_DIR}"
mkdir -p "${PKG_DIR}/bin" "${PKG_DIR}/crates" "${PKG_DIR}/src" "${PKG_DIR}/docs" "${PKG_DIR}/frontend"
# 3.1 预编译二进制
cp "${BIN}" "${PKG_DIR}/bin/sspf-admin"
BIN_SIZE="$(du -h "${PKG_DIR}/bin/sspf-admin" | cut -f1)"
echo "==> bin/sspf-admin (${BIN_SIZE})"
# 3.2 计算 sspf 的 path 依赖闭包(纯文件系统 BFS,离线安全;不含 sspf-admin 自身源码)
# 输出每行:源目录<TAB>包内相对目标
CLOSURE="$(python3 - <<'PY'
import os, re
root=os.getcwd()
start=os.path.join(root,"crates","sspf")
seen=set()
def resolve(cdir):
ct=os.path.join(cdir,"Cargo.toml")
if not os.path.isfile(ct): return
seen.add(os.path.normpath(cdir))
txt=open(ct).read()
for m in re.finditer(r'path\s*=\s*"([^"]+)"', txt):
nd=os.path.normpath(os.path.join(cdir, m.group(1)))
if os.path.isdir(nd) and nd not in seen:
resolve(nd)
resolve(start)
for d in sorted(seen):
rel=os.path.relpath(d, root)
if rel=="src/backend":
print(f"{rel}\tsrc/backend")
else:
print(f"{rel}\t{rel}") # crates/xxx -> crates/xxx
PY
)"
RSYNC_EXCLUDES=(
--exclude target --exclude .git
--exclude __pycache__ --exclude '*.pyc'
--exclude node_modules --exclude .vite --exclude dist
)
CRATE_N=0
while IFS=$'\t' read -r src dst; do
[[ -z "${src}" ]] && continue
rsync -a "${RSYNC_EXCLUDES[@]}" "${src}/" "${PKG_DIR}/${dst}/"
if [[ "${dst}" == crates/* ]]; then CRATE_N=$((CRATE_N+1)); fi
done <<< "${CLOSURE}"
echo "==> 复制 ${CRATE_N} 个 crate + src/backend(闭包)"
# 3.3 workspace 根 + lock + toolchain(消费方 --offline 解析继承字段靠它们)
cp Cargo.toml Cargo.lock rust-toolchain.toml "${PKG_DIR}/"
echo "==> Cargo.toml / Cargo.lock / rust-toolchain.toml"
# 3.4 消费方式说明
cp docs/SSPF-PLATFORM-PACKAGE.md "${PKG_DIR}/docs/"
# 3.5 平台前端源码(不含 node_modules/dist,可选随包;C 用户明确「前端可以留着」)
if [[ -d src/frontend ]]; then
rsync -a "${RSYNC_EXCLUDES[@]}" src/frontend/ "${PKG_DIR}/frontend/"
echo "==> frontend/(源码,已排除 node_modules/dist)"
fi
# 3.6 生成包内 README
cat > "${PKG_DIR}/README.md" <<EOF
# sspf 标准平台包 v${VERSION}
本包是 \`ssw-platform\` 仓每个版本产出的**自包含发布包**,供技能 / 业务项目(消费方)
依赖使用。**消费方不应直接依赖 git 仓**,而是把本包解包到 \`vendor/\` 后用 \`path\` 依赖吃进去。
## 包里有什么
| 路径 | 用途 |
|---|---|
| \`bin/sspf-admin\` | 🔴 预编译的 sspf-admin 二进制(字面,平台侧已 release 编译),可直接跑 |
| \`crates/*\` | 🔴 平台 crate 自包含源码(sspf 门面 + 其 path 依赖闭包,共 ${CRATE_N} 个) |
| \`src/backend/\` | 🔴 内核 lib(ssw-platform)—— sspf 的 path 依赖 |
| \`Cargo.toml\` | 🔴 workspace 根(crate 的 \`version.workspace = true\` 靠它解析) |
| \`Cargo.lock\` | 🔴 锁定整个闭包,消费方 \`--offline\` 也能编译 |
| \`rust-toolchain.toml\` | 工具链版本(信息性;消费方需自带同名文件,rustup 按 cwd 选版本) |
| \`docs/SSPF-PLATFORM-PACKAGE.md\` | 平台侧需求文档与消费方式说明 |
| \`frontend/\` | 平台前端源码(不含 node_modules/dist) |
## 消费方怎么用
1. 把本包解包到消费方仓库的 \`vendor/sspf-v${VERSION}/\`。
2. 在消费方 \`Cargo.toml\` 里(建议放在 \`[workspace.dependencies]\`):
\`\`\`toml
sspf = { path = "vendor/sspf-v${VERSION}/crates/sspf", version = "${VERSION%.*}" }
\`\`\`
3. 消费方 \`.gitignore\` 加 \`vendor/\`。
4. \`cargo build\` 即可(平台库仍会编译一次,Rust 库常态;但不再碰 git、不再 clone monorepo)。
详见平台仓 \`docs/SSPF-PLATFORM-PACKAGE.md\` §6。
## 工具链
全仓锁 \`rustc $(grep -m1 channel rust-toolchain.toml | sed 's/.*= *"//;s/"//')\`(L3 dylib 的 ABI 前提)。
消费方必须自带同名 \`rust-toolchain.toml\`,平台侧无法代劳。
EOF
echo "==> README.md"
# ── 4. 打 tar.gz ───────────────────────────────────────────────
TAR="${DIST_DIR}/${PKG}.tar.gz"
tar -czf "${TAR}" -C "${DIST_DIR}" "${PKG}"
TAR_SIZE="$(du -h "${TAR}" | cut -f1)"
echo "==> 已打包: ${TAR} (${TAR_SIZE})"
# ── 5. 自检:包内 path 依赖闭包能否被最小消费方离线编译 ────────
echo "==> 自检验证中(构造最小消费方,--offline 编译)"
TMPCON="$(mktemp -d)"
cat > "${TMPCON}/Cargo.toml" <<EOF
[package]
name = "pkg-selfcheck"
version = "0.0.0"
edition = "2021"
[dependencies]
sspf = { path = "${REPO_ROOT}/${PKG_DIR}/crates/sspf" }
tokio = { version = "1", features = ["full"] }
EOF
mkdir -p "${TMPCON}/src"
# 复用包的 Cargo.lock(已锁定整个闭包),让消费方 --offline 也能解析 registry 依赖
cp "${REPO_ROOT}/${PKG_DIR}/Cargo.lock" "${TMPCON}/Cargo.lock"
cat > "${TMPCON}/src/main.rs" <<'EOF'
use sspf::Platform;
fn main() {
println!("sspf VERSION = {}", sspf::VERSION);
let _ = Platform::new();
println!("OK: path-dep closure resolves & compiles");
}
EOF
if (cd "${TMPCON}" && cargo build --offline 2>&1 | tail -3); then
echo "==> ✅ 自检通过:${PKG} 可被最小消费方 --offline 编译"
else
echo "!! ❌ 自检失败:包内闭包无法离线编译,请检查 Cargo.lock / workspace 根" >&2
rm -rf "${TMPCON}"
exit 1
fi
rm -rf "${TMPCON}"
echo ""
echo "=================================================="
echo "✅ 出包完成: ${PKG}"
echo " 目录: ${PKG_DIR}"
echo " 压缩包: ${TAR} (${TAR_SIZE})"
echo " 预编译二进制: bin/sspf-admin (${BIN_SIZE})"
echo " crate 闭包: ${CRATE_N} 个 + src/backend"
echo "=================================================="