[action] add action for auto release zip with git tag (#47)

Author: SunnyHaze

.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: build-and-release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+          # 如果你没有 frontend/package-lock.json，这行可以删掉
+          cache-dependency-path: frontend/package-lock.json
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install system deps
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y zip rsync
+
+      - name: Build release zip (single source of truth)
+        run: |
+          chmod +x scripts/build_release.sh
+          ./scripts/build_release.sh "${GITHUB_REF_NAME}"
+
+      - name: Create GitHub Release & upload asset
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            DataFlow-WebUI-*.zip
+          generate_release_notes: true

.gitignore

@@ -0,0 +1,3 @@
+*.zip
+__pycache__
+dist_release/

README-release-en.md

@@ -0,0 +1,52 @@
+# DataFlow-WebUI (Release)
+
+## English · Quick Start
+
+### 1. Prepare Python
+
+* Python **3.10 / 3.11** is recommended
+* Make sure `python` is available in your shell
+
+Choose one:
+
+**Option A: venv**
+
+```bash
+python -m venv .venv
+source .venv/bin/activate   # Windows: .venv\Scripts\activate
+```
+
+**Option B: conda**
+
+```bash
+conda create -n dataflow python=3.10
+conda activate dataflow
+```
+
+### 2. Install backend dependencies
+
+```bash
+cd backend
+pip install -r requirements.txt
+cd ..
+```
+
+### 3. Run
+
+From the **release root directory**:
+
+```bash
+./run.sh
+```
+
+Windows:
+
+```bat
+run.bat
+```
+
+Open in browser:
+
+```
+http://localhost:8000/ui/
+```

README-release-zh.md

@@ -0,0 +1,50 @@
+# DataFlow-WebUI (Release)
+
+## 中文 · 快速开始
+
+### 1. 准备 Python 环境
+- 推荐 Python **3.10 / 3.11**
+- 确保命令行可以直接使用 `python`
+
+你可以任选一种方式：
+
+**方式 A：venv**
+```bash
+python -m venv .venv
+source .venv/bin/activate   # Windows: .venv\Scripts\activate
+```
+
+**方式 B：conda**
+
+```bash
+conda create -n dataflow python=3.10
+conda activate dataflow
+```
+
+### 2. 安装后端依赖
+
+```bash
+cd backend
+pip install -r requirements.txt
+cd ..
+```
+
+### 3. 启动服务
+
+在 **解压后的根目录** 直接运行：
+
+```bash
+./run.sh
+```
+
+Windows：
+
+```bat
+run.bat
+```
+
+然后在浏览器打开：
+
+```
+http://localhost:8000/ui/
+```

frontend/.gitignore

@@ -29,3 +29,7 @@ coverage
 *.sw?
 
 *.tsbuildinfo
+
+
+package-lock.json
+yarn.lock

scripts/build_release.sh

@@ -0,0 +1,118 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# 用法:
+#   ./scripts/build_release.sh v0.1.0
+# 不传则自动用当前 tag；没 tag 就用 commit 短哈希
+VERSION="${1:-}"
+
+ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+FRONTEND_DIR="$ROOT_DIR/frontend"
+BACKEND_DIR="$ROOT_DIR/backend"
+
+OUT_STAGING="$ROOT_DIR/dist_release"
+PKG_NAME=""
+ZIP_NAME=""
+
+# ---- 版本号推断 ----
+if [[ -z "$VERSION" ]]; then
+  if git -C "$ROOT_DIR" describe --tags --exact-match >/dev/null 2>&1; then
+    VERSION="$(git -C "$ROOT_DIR" describe --tags --exact-match)"
+  else
+    VERSION="dev-$(git -C "$ROOT_DIR" rev-parse --short HEAD)"
+  fi
+fi
+
+PKG_NAME="DataFlow-WebUI-$VERSION"
+ZIP_NAME="$PKG_NAME.zip"
+
+echo "[build_release] VERSION=$VERSION"
+echo "[build_release] PKG_NAME=$PKG_NAME"
+
+# ---- 依赖检查（尽早失败）----
+command -v node >/dev/null 2>&1 || { echo "node not found"; exit 1; }
+command -v npm  >/dev/null 2>&1 || { echo "npm not found"; exit 1; }
+command -v python >/dev/null 2>&1 || { echo "python not found"; exit 1; }
+command -v zip >/dev/null 2>&1 || { echo "zip not found (ubuntu: apt-get install zip)"; exit 1; }
+command -v rsync >/dev/null 2>&1 || { echo "rsync not found (ubuntu: apt-get install rsync)"; exit 1; }
+
+# ---- 清理 staging ----
+rm -rf "$OUT_STAGING"
+mkdir -p "$OUT_STAGING/$PKG_NAME"
+
+# ---- 1) 构建前端（你现在 dist 已在 frontend/ 下）----
+echo "[build_release] Building frontend..."
+pushd "$FRONTEND_DIR" >/dev/null
+# 你仓库里是 yarn.lock；若你更想用 yarn，就把 npm ci 换成 yarn install --frozen-lockfile
+# 这里先用 npm（要求有 package-lock.json）；如果你没 lock，建议改用 yarn
+if [[ -f "package-lock.json" ]]; then
+  npm ci
+  npm run build
+else
+  echo "No package-lock.json found, using npm install (consider using yarn with yarn.lock)."
+  npm install
+  npm run build
+fi
+popd >/dev/null
+
+# dist 必须存在
+if [[ ! -d "$FRONTEND_DIR/dist" ]]; then
+  echo "[build_release] ERROR: frontend/dist not found after build."
+  exit 1
+fi
+
+# ---- 2) 组装发布包：保持你的目录结构 backend/ + frontend/dist ----
+echo "[build_release] Assembling package..."
+
+# 2.1 后端：复制 backend/（排除 tests、cache、pycache 等）
+rsync -a \
+  --exclude "__pycache__" \
+  --exclude ".venv" \
+  --exclude ".pytest_cache" \
+  --exclude "tests" \
+  --exclude "cache_local" \
+  "$BACKEND_DIR/" \
+  "$OUT_STAGING/$PKG_NAME/backend/"
+
+# 2.2 前端：只复制 dist（不带 node_modules/src 等）
+mkdir -p "$OUT_STAGING/$PKG_NAME/frontend"
+rsync -a --delete \
+  "$FRONTEND_DIR/dist/" \
+  "$OUT_STAGING/$PKG_NAME/frontend/dist/"
+
+# 2.3 顶层文档（可选）
+[[ -f "$ROOT_DIR/README-release-en.md" ]] && cp "$ROOT_DIR/README-release-en.md" "$OUT_STAGING/$PKG_NAME/"
+[[ -f "$ROOT_DIR/README-release-zh.md" ]] && cp "$ROOT_DIR/README-release-zh.md" "$OUT_STAGING/$PKG_NAME/"
+[[ -f "$ROOT_DIR/LICENSE" ]] && cp "$ROOT_DIR/LICENSE" "$OUT_STAGING/$PKG_NAME/" || true
+
+# ---- 3) 一键启动脚本 ----
+# 关键：从 release 根目录启动，保证 backend 里用 ../frontend/dist 能找到前端资源
+cat > "$OUT_STAGING/$PKG_NAME/run.sh" <<'EOF'
+#!/usr/bin/env bash
+set -e
+cd "$(dirname "$0")"
+
+# 后端依赖
+cd backend
+
+uvicorn app.main:app --reload --port 8000  --reload-dir app --host=0.0.0.0
+EOF
+chmod +x "$OUT_STAGING/$PKG_NAME/run.sh"
+
+cat > "$OUT_STAGING/$PKG_NAME/run.bat" <<'EOF'
+@echo off
+setlocal
+cd /d "%~dp0"
+
+cd backend
+
+uvicorn app.main:app --reload --port 8000  --reload-dir app --host=0.0.0.0
+EOF
+
+# ---- 4) 打 zip ----
+echo "[build_release] Creating zip..."
+pushd "$OUT_STAGING" >/dev/null
+zip -r "$ROOT_DIR/$ZIP_NAME" "$PKG_NAME"
+popd >/dev/null
+
+echo "[build_release] Done: $ROOT_DIR/$ZIP_NAME"