部署脚本跨平台化:新增 scripts/deploy.mjs、rollback.mjs 及远程执行脚本,package.json 改用 node 执行;移除根目录 deploy.sh/rollback.sh;部署配置独立到 scripts/deploy.config.json 并加入 .gitignore 不跟踪

This commit is contained in:
liufumingren 2026-08-30 08:30:04 +08:00
parent 6c8843e85b
commit 08b3dc4739
8 changed files with 174 additions and 76 deletions

3
.gitignore vendored
View File

@ -15,6 +15,9 @@ dist.tar.gz
coverage
*.local
# 部署配置(含服务器/密钥信息,不纳入版本控制)
/scripts/deploy.config.json
# Editor directories and files
.vscode/*
!.vscode/extensions.json

View File

@ -24,8 +24,8 @@
"lint:fix": "eslint . --cache --fix",
"format": "prettier . --write",
"format:check": "prettier . --check",
"deploy": "sh deploy.sh",
"rollback": "sh rollback.sh"
"deploy": "node ./scripts/deploy.mjs",
"rollback": "node ./scripts/rollback.mjs"
},
"dependencies": {
"@element-plus/icons-vue": "^2.3.2",

View File

@ -1,31 +0,0 @@
#!/bin/bash
set -eu
USER="webdev"
IP="112.124.21.102" # 服务器 IP
BASE_PATH="/www/wwwroot/web" # 项目在服务器上的存放路径
# SSH 密钥提示:请确保本地已将 id_ed25519.pub 添加到服务器的 ~/.ssh/authorized_keys
# 密钥内容:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAICJtwa+MFLQEgkEbcGQ6dkQOiFydRvjVeidJ/7uBsF2e 3313488199@qq.com
SSH_KEY="$HOME/.ssh/id_ed25519_admin"
SSH_OPTS="-i $SSH_KEY -o StrictHostKeyChecking=no"
echo "⏪ 正在回滚到上一个版本..."
ssh $SSH_OPTS $USER@$IP "BASE='$BASE_PATH' bash -s" << 'REMOTE_EOF'
set -euo pipefail
# 获取 releases 目录下按时间排序的倒数第二个版本(当前版本的上一版)
PREVIOUS_VERSION="$(ls -dt "$BASE"/releases/*/ 2>/dev/null | sed -n '2p' || true)"
if [ -z "$PREVIOUS_VERSION" ]; then
echo "❌ 找不到可回滚的历史版本"
exit 1
fi
# 原子切换软链接(与发版脚本一致,切换瞬间服务不中断)
ln -sfn "$PREVIOUS_VERSION" "$BASE/current_new"
mv -Tf "$BASE/current_new" "$BASE/current"
echo "✅ 已回滚至: $PREVIOUS_VERSION"
REMOTE_EOF

View File

@ -0,0 +1,8 @@
{
"user": "root",
"ip": "112.124.21.102",
"basePath": "/www/wwwroot/web",
"keepReleases": 5,
"siteHost": "wms.wms.gztbyc.com",
"sshKey": "C:\\Users\\lfmingren\\.ssh\\112.124.21.102_id_ed25519"
}

96
scripts/deploy.mjs Normal file
View File

@ -0,0 +1,96 @@
#!/usr/bin/env node
/**
* 跨平台发布脚本(Windows / macOS / Linux 通用)
*
* 等价于原 deploy.sh,改用 Node.js 实现,使 Windows 开发环境无需安装 sh/bash。
* 依赖本机已安装:ssh、scp、tar(Windows 10 1803+ 自带 OpenSSH 客户端与 bsdtar)。
*
* 用法:npm run deploy
*/
import { spawnSync } from 'node:child_process';
import { existsSync, readFileSync, rmSync } from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import { fileURLToPath } from 'node:url';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
// --- 配置(读取独立配置文件,该文件不纳入版本控制) ---
const CONFIG_PATH = path.join(__dirname, 'deploy.config.json');
if (!existsSync(CONFIG_PATH)) {
console.error('❌ 缺少配置文件 deploy.config.json');
console.error(' 请复制 scripts/deploy.config.example.json 为 scripts/deploy.config.json 并修改其中参数。');
process.exit(1);
}
const config = JSON.parse(readFileSync(CONFIG_PATH, 'utf8'));
const USER = config.user;
const IP = config.ip; // 服务器 IP
const BASE_PATH = config.basePath; // 项目在服务器上的存放路径
const KEEP_RELEASES = config.keepReleases; // 服务器上保留的最近版本数
const SITE_HOST = config.siteHost; // 发版后健康检查域名
const LOCAL_DIST = path.resolve('dist');
const SSH_KEY = path.join(os.homedir(), '.ssh', config.sshKey);
const SSH_OPTS = ['-i', SSH_KEY, '-o', 'StrictHostKeyChecking=no'];
const HOST = `${USER}@${IP}`;
const TARBALL = 'dist.tar.gz';
const NPM = process.platform === 'win32' ? 'npm.cmd' : 'npm';
const RELEASE_NAME = `v${timestamp()}_${process.pid}`; // 版本号(带 PID,避免并发/重复发布冲突)
const REMOTE_RELEASE = `${BASE_PATH}/releases/${RELEASE_NAME}`;
function timestamp() {
const d = new Date();
const p = (n) => String(n).padStart(2, '0');
return `${d.getFullYear()}${p(d.getMonth() + 1)}${p(d.getDate())}_${p(d.getHours())}${p(d.getMinutes())}${p(d.getSeconds())}`;
}
function run(cmd, args, opts = {}) {
const res = spawnSync(cmd, args, { stdio: 'inherit', ...opts });
if (res.error) {
console.error(`❌ 无法执行命令 ${cmd}: ${res.error.message}`);
if (res.error.code === 'ENOENT') {
console.error(
' 请确认本机已安装对应命令(ssh/scp/tar)。Windows 10 1803+ 自带 OpenSSH 客户端与 tar。'
);
}
process.exit(1);
}
if (res.status !== 0) process.exit(res.status ?? 1);
}
console.log(`🚀 开始发布版本: ${RELEASE_NAME}`);
try {
// 1. 本地打包(失败立即中止,防止把坏产物发到线上)
run(NPM, ['run', 'build']);
// 2. 校验本地产物完整性
if (!existsSync(path.join(LOCAL_DIST, 'index.html')) || !existsSync(path.join(LOCAL_DIST, 'assets'))) {
console.error('❌ 本地构建产物不完整(缺少 index.html 或 assets),中止发布');
process.exit(1);
}
// 3. 压缩并上传到独立的新版本目录(全程不触碰当前运行目录)
run('tar', ['-czf', TARBALL, '-C', LOCAL_DIST, '.']);
run('ssh', [...SSH_OPTS, HOST, `mkdir -p '${REMOTE_RELEASE}'`]);
run('scp', [...SSH_OPTS, TARBALL, `${HOST}:${REMOTE_RELEASE}/${TARBALL}`]);
// 4. 远程:解压 → 校验 → 补齐旧资源 → 原子切换 → 健康检查 → 清理
const remoteScript = readFileSync(path.join(__dirname, 'remote', 'deploy.sh'), 'utf8');
run(
'ssh',
[
...SSH_OPTS,
HOST,
`RELEASE='${REMOTE_RELEASE}' BASE='${BASE_PATH}' KEEP=${KEEP_RELEASES} HOST='${SITE_HOST}' bash -s`,
],
{ input: remoteScript, stdio: ['pipe', 'inherit', 'inherit'] }
);
console.log(`✨ 发布成功!当前版本: ${RELEASE_NAME}`);
} finally {
// 无论成功失败都清理本地临时压缩包
rmSync(TARBALL, { force: true });
}

View File

@ -1,43 +1,3 @@
#!/bin/bash
set -eu
# --- 配置 ---
USER="webdev"
IP="112.124.21.102" # 服务器 IP
BASE_PATH="/www/wwwroot/web" # 项目在服务器上的存放路径
RELEASE_NAME="v$(date +'%Y%m%d_%H%M%S')_$$" # 版本号(带 PID,避免并发/重复发布冲突)
LOCAL_DIST="./dist"
KEEP_RELEASES=5 # 服务器上保留的最近版本数
SITE_HOST="wms.wms.gztbyc.com" # 发版后健康检查域名
# SSH 密钥提示:请确保本地已将 id_ed25519.pub 添加到服务器的 ~/.ssh/authorized_keys
# 密钥内容:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAICJtwa+MFLQEgkEbcGQ6dkQOiFydRvjVeidJ/7uBsF2e 3313488199@qq.com
SSH_KEY="$HOME/.ssh/id_ed25519_admin"
SSH_OPTS="-i $SSH_KEY -o StrictHostKeyChecking=no"
REMOTE_RELEASE="$BASE_PATH/releases/$RELEASE_NAME"
# 无论成功失败都清理本地临时压缩包
trap 'rm -f dist.tar.gz' EXIT
echo "🚀 开始发布版本: $RELEASE_NAME"
# 1. 本地打包(失败立即中止,防止把坏产物发到线上)
npm run build
# 2. 校验本地产物完整性
if [ ! -f "$LOCAL_DIST/index.html" ] || [ ! -d "$LOCAL_DIST/assets" ]; then
echo "❌ 本地构建产物不完整(缺少 index.html 或 assets),中止发布"
exit 1
fi
# 3. 压缩并上传到独立的新版本目录(全程不触碰当前运行目录)
tar -czf dist.tar.gz -C "$LOCAL_DIST" .
ssh $SSH_OPTS $USER@$IP "mkdir -p '$REMOTE_RELEASE'"
scp $SSH_OPTS dist.tar.gz $USER@$IP:"$REMOTE_RELEASE/dist.tar.gz"
# 4. 远程:解压 → 校验 → 补齐旧资源 → 原子切换 → 健康检查 → 清理
ssh $SSH_OPTS $USER@$IP "RELEASE='$REMOTE_RELEASE' BASE='$BASE_PATH' KEEP=$KEEP_RELEASES HOST='$SITE_HOST' bash -s" << 'REMOTE_EOF'
set -euo pipefail
cd "$RELEASE"
@ -89,6 +49,3 @@ for d in $(ls -t "$BASE/releases" 2>/dev/null || true); do
[ "$target" = "$CURRENT_TARGET" ] && continue
rm -rf "$BASE/releases/$d"
done
REMOTE_EOF
echo "✨ 发布成功!当前版本: $RELEASE_NAME"

View File

@ -0,0 +1,15 @@
set -euo pipefail
# 获取 releases 目录下按时间排序的倒数第二个版本(当前版本的上一版)
PREVIOUS_VERSION="$(ls -dt "$BASE"/releases/*/ 2>/dev/null | sed -n '2p' || true)"
if [ -z "$PREVIOUS_VERSION" ]; then
echo "❌ 找不到可回滚的历史版本"
exit 1
fi
# 原子切换软链接(与发版脚本一致,切换瞬间服务不中断)
ln -sfn "$PREVIOUS_VERSION" "$BASE/current_new"
mv -Tf "$BASE/current_new" "$BASE/current"
echo "✅ 已回滚至: $PREVIOUS_VERSION"

50
scripts/rollback.mjs Normal file
View File

@ -0,0 +1,50 @@
#!/usr/bin/env node
/**
* 跨平台回滚脚本(Windows / macOS / Linux 通用)
*
* 等价于原 rollback.sh,改用 Node.js 实现,使 Windows 开发环境无需安装 sh/bash。
* 依赖本机已安装:ssh(Windows 10 1803+ 自带 OpenSSH 客户端)。
*
* 用法:npm run rollback
*/
import { spawnSync } from 'node:child_process';
import { existsSync, readFileSync } from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import { fileURLToPath } from 'node:url';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
// --- 配置(读取独立配置文件,该文件不纳入版本控制) ---
const CONFIG_PATH = path.join(__dirname, 'deploy.config.json');
if (!existsSync(CONFIG_PATH)) {
console.error('❌ 缺少配置文件 deploy.config.json');
console.error(' 请复制 scripts/deploy.config.example.json 为 scripts/deploy.config.json 并修改其中参数。');
process.exit(1);
}
const config = JSON.parse(readFileSync(CONFIG_PATH, 'utf8'));
const USER = config.user;
const IP = config.ip; // 服务器 IP
const BASE_PATH = config.basePath; // 项目在服务器上的存放路径
const SSH_KEY = path.join(os.homedir(), '.ssh', config.sshKey);
const SSH_OPTS = ['-i', SSH_KEY, '-o', 'StrictHostKeyChecking=no'];
const HOST = `${USER}@${IP}`;
console.log('⏪ 正在回滚到上一个版本...');
const remoteScript = readFileSync(path.join(__dirname, 'remote', 'rollback.sh'), 'utf8');
const res = spawnSync(
'ssh',
[...SSH_OPTS, HOST, `BASE='${BASE_PATH}' bash -s`],
{ input: remoteScript, stdio: ['pipe', 'inherit', 'inherit'] }
);
if (res.error) {
console.error(`❌ 无法执行 ssh: ${res.error.message}`);
if (res.error.code === 'ENOENT') {
console.error(' 请确认本机已安装 OpenSSH 客户端(Windows 10 1803+ 自带)。');
}
process.exit(1);
}
process.exit(res.status ?? 1);