优化网站部署流程:简化目录布局与 symlink 方案

Author: zerx-lab

.github/workflows/deploy_website.yml

@@ -42,24 +42,26 @@ jobs:
           chmod 600 ~/.ssh/deploy_key
           ssh-keyscan -p "${{ secrets.DEPLOY_PORT || '22' }}" -H "${{ secrets.DEPLOY_HOST }}" >> ~/.ssh/known_hosts 2>/dev/null
 
-      - name: Rsync dist to server incoming/
+      - name: Rsync dist to server (.incoming)
         env:
           PORT: ${{ secrets.DEPLOY_PORT || '22' }}
           USER: ${{ secrets.DEPLOY_USER }}
           HOST: ${{ secrets.DEPLOY_HOST }}
+          # DEPLOY_PATH = 站点 index 目录,例如 /opt/1panel/www/sites/zap.zerx.dev/index
           DEPLOY_PATH: ${{ secrets.DEPLOY_PATH }}
         run: |
-          # 确保远端目录存在
+          # 在站点父目录(index 的上一级)准备暂存区与脚本目录
+          PARENT="$(dirname "$DEPLOY_PATH")"
           ssh -i ~/.ssh/deploy_key -p "$PORT" "$USER@$HOST" \
-            "mkdir -p '$DEPLOY_PATH/incoming' '$DEPLOY_PATH/deploy'"
-          # 推送静态产物(--delete 保证 incoming 与本地 dist 完全一致)
+            "mkdir -p '$PARENT/.incoming'"
+          # 推送静态产物到 .incoming(--delete 保证与本地 dist 完全一致)
           rsync -az --delete \
             -e "ssh -i ~/.ssh/deploy_key -p $PORT" \
-            dist/ "$USER@$HOST:$DEPLOY_PATH/incoming/"
-          # 推送部署脚本
+            dist/ "$USER@$HOST:$PARENT/.incoming/"
+          # 推送部署脚本到父目录
           rsync -az \
             -e "ssh -i ~/.ssh/deploy_key -p $PORT" \
-            deploy/deploy.sh "$USER@$HOST:$DEPLOY_PATH/deploy/deploy.sh"
+            deploy/deploy.sh "$USER@$HOST:$PARENT/deploy.sh"
 
       - name: Run remote deploy script
         env:
@@ -68,9 +70,11 @@ jobs:
           HOST: ${{ secrets.DEPLOY_HOST }}
           DEPLOY_PATH: ${{ secrets.DEPLOY_PATH }}
         run: |
-          # 远端赋予执行权限并运行,避免 pull/上传后无执行权限的问题
+          # 远端赋予执行权限并运行,把正式 index 目录作为参数传入
+          # 避免 pull/上传后无执行权限的问题:每次都 chmod +x
+          PARENT="$(dirname "$DEPLOY_PATH")"
           ssh -i ~/.ssh/deploy_key -p "$PORT" "$USER@$HOST" \
-            "chmod +x '$DEPLOY_PATH/deploy/deploy.sh' && '$DEPLOY_PATH/deploy/deploy.sh'"
+            "chmod +x '$PARENT/deploy.sh' && '$PARENT/deploy.sh' '$DEPLOY_PATH'"
 
       - name: Cleanup SSH key
         if: always()

website/deploy/deploy.sh

@@ -1,50 +1,40 @@
 #!/usr/bin/env bash
 # Zap 官网部署脚本(在服务器上执行)
 #
-# 由 GitHub Actions 上传到 $DEPLOY_PATH/deploy/deploy.sh 后,经 chmod +x 远程执行。
-# 职责:把上传好的静态产物(dist/)切换为对外服务目录,做原子发布 + 保留回滚。
+# 场景:站点由 1Panel 托管,nginx root 固定指向站点目录(例如
+#   /opt/1panel/www/sites/zap.zerx.dev/index),无法改 root 用 symlink 方案。
+# 故这里做"原子目录替换":CI 已把最新产物 rsync 到 <site>/.incoming,
+# 本脚本把 .incoming 重命名为正式 index 目录,并保留上一版用于回滚。
 #
-# 约定的目录布局($DEPLOY_PATH 下):
-#   incoming/   ← Actions 用 rsync 推上来的最新 dist 内容
-#   releases/<ts>/ ← 每次发布的快照
-#   current     ← symlink,指向当前生效的 releases/<ts>(nginx root 指这里)
-#
-# nginx 的 root 应配置为 $DEPLOY_PATH/current
+# 约定布局($DEPLOY_PATH = 站点 index 目录,例如 .../zap.zerx.dev/index):
+#   <parent>/.incoming   ← CI rsync 推上来的最新 dist 内容
+#   <parent>/index       ← nginx 实际服务的目录(= $DEPLOY_PATH)
+#   <parent>/.index.bak  ← 上一版,用于回滚
 set -euo pipefail
 
-# 部署根目录:脚本位于 <root>/deploy/deploy.sh,故根目录是脚本上两级
-ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
-INCOMING="$ROOT/incoming"
-RELEASES="$ROOT/releases"
-CURRENT="$ROOT/current"
-KEEP=5  # 保留最近多少份 release 用于回滚
+# $DEPLOY_PATH 由调用方(SSH 命令)以第一个参数传入,即正式 index 目录
+INDEX="${1:?用法: deploy.sh <site-index-dir>}"
+PARENT="$(dirname "$INDEX")"
+INCOMING="$PARENT/.incoming"
+BACKUP="$PARENT/.index.bak"
 
 log() { printf '[deploy] %s\n' "$*"; }
 
 if [ ! -d "$INCOMING" ] || [ -z "$(ls -A "$INCOMING" 2>/dev/null)" ]; then
-  log "错误:$INCOMING 不存在或为空,没有可发布的产物。先由 CI rsync 产物到 incoming/。"
+  log "错误:$INCOMING 不存在或为空,没有可发布的产物(先由 CI rsync 到 .incoming)。"
   exit 1
 fi
 
-TS="$(date +%Y%m%d%H%M%S)"
-TARGET="$RELEASES/$TS"
-
-mkdir -p "$RELEASES"
-log "创建发布快照:$TARGET"
-# 用 cp -a 从 incoming 物化一份不可变快照,保证 current 切换是原子的
-cp -a "$INCOMING" "$TARGET"
-
-# 原子切换 current symlink:先建临时 link 再 rename,避免出现短暂无 current 的窗口
-log "切换 current -> releases/$TS"
-ln -sfn "$TARGET" "$CURRENT.tmp"
-mv -Tf "$CURRENT.tmp" "$CURRENT"
+# 删除上一版备份,把当前 index 移为备份(若存在)
+if [ -e "$INDEX" ]; then
+  log "备份当前版本 -> $BACKUP"
+  rm -rf "$BACKUP"
+  mv -Tf "$INDEX" "$BACKUP"
+fi
 
-# 清理旧 release,保留最近 $KEEP 份
-log "清理旧 release,保留最近 $KEEP 份"
-cd "$RELEASES"
-ls -1dt */ 2>/dev/null | tail -n +$((KEEP + 1)) | while read -r old; do
-  log "  删除 $old"
-  rm -rf "${RELEASES:?}/${old%/}"
-done
+# 原子上线:rename .incoming -> index(同一文件系统,mv 为原子操作)
+log "发布新版本 -> $INDEX"
+mv -Tf "$INCOMING" "$INDEX"
 
-log "完成。current 现指向:$(readlink -f "$CURRENT")"
+log "完成。当前服务目录:$INDEX"
+log "如需回滚:rm -rf '$INDEX' && mv -Tf '$BACKUP' '$INDEX'"