SHA256
forked from course-team/tjhlp-gitea
事故经过(2026-09-22): 「提问指南」换地址那个提交推送后 CI 挂了, auto-deploy 回滚。 check.sh 报「没找到官网提问指南链接 / 仍有旧地址」—— 但脚本确实把部署克隆同步到了新 提交、语言文件也重新生成了。原来 deploy() 比较的是 build.py 运行【前后】的指纹: 那只能 发现语言文件被重新生成, 纯模板改动前后完全一样 → 从不重启 → 容器继续用启动时加载的旧 模板 → 断言失败 → 整个部署被判失败并回滚。也就是说: 任何只改模板的提交都必然挂 CI。 修法: 把指纹记在 deploy/.state/custom-hash 里, 与【上次成功部署】的指纹比较, 不同就 restart gitea(restart 而不是 up -d: compose 配置没变时 up -d 不重建容器)。rollback 路径 改成 deploy force 无条件重启 —— 失败的那次可能已经用新模板重启过容器, 回滚必须再重启 回去, 顺便也修好下面这个副作用。 顺带修一个 bind mount 的坑: 挂载【源目录】被「删掉再建」后容器里挂的还是旧 inode(空 目录)。这次事故里 public/ 下的文件被删光、git 顺手删掉空目录, 于是线上 /QA/assets/tjhlp/ask-guide.html 变成 404。已在预览上复现([B] 404 → restart 后 [C] 200), restart 会重新解析挂载, 所以上面的修法同时把它修好。 验证(不碰生产的沙箱, 假 docker + 桩 verify/check): 1 全新状态首次部署 → up -d + restart ✓ 2 什么都没改再部署 → 不重启 ✓ 3 只改一个模板文件 → 重启 ✓(这次的回归点) 4 之后再来一次 → 不重启 ✓ 5 check 失败 → 回滚 → checkout PREV + 强制 restart ✓, 状态文件不被污染 ✓ 另外 check.sh / preview.sh 的失败信息里加了「模板改动要重启才生效」的提示, 并把 ci-cd.md §5.2(脚本清单+为什么必须 restart)与 README §12 速查表同步更新。
161 lines
7.4 KiB
Bash
Executable File
161 lines
7.4 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# main 自动部署 —— 由 .gitea/workflows/deploy.yml 调用, 也可以手工执行。
|
|
#
|
|
# ./auto-deploy.sh # 部署当前 checkout
|
|
# ./auto-deploy.sh <sha> # 部署指定提交
|
|
#
|
|
# 流程: build.py(生成+校验) → docker compose up -d → custom/ 与上次成功部署的指纹不同
|
|
# 就重启 gitea(模板/语言文件是启动时加载的) → 验证(verify.sh + check.sh)
|
|
# → 成功则记下 .state/{last-deployed,custom-hash}
|
|
# 任一步失败 → 回滚到 deploy/.state/last-deployed 记录的上一个成功提交并强制重启。
|
|
# 只动代码与挂载文件; 数据库/`.env`/备份目录全程不参与(见 deploy/ci-cd.md §6)。
|
|
set -euo pipefail
|
|
|
|
REPO_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
|
STATE_DIR="${REPO_DIR}/deploy/.state"
|
|
STATE_FILE="${STATE_DIR}/last-deployed"
|
|
HASH_FILE="${STATE_DIR}/custom-hash" # 上次成功部署时 customization/custom/ 的指纹
|
|
PUBLIC_URL="${GITEA_PUBLIC_URL:-http://10.80.42.185/QA}"
|
|
|
|
# 本机/内网回环验证不能走代理, 否则会把 200 变成 502(见 deploy/README.md 陷阱 5)
|
|
unset http_proxy https_proxy HTTP_PROXY HTTPS_PROXY
|
|
export no_proxy='*' NO_PROXY='*'
|
|
# 只补齐标准路径(append): 不要把 /usr/bin 提到最前面 —— 宿主上 /usr/bin/python3 是 3.6
|
|
export PATH="${PATH}:/usr/local/bin:/usr/bin:/bin"
|
|
|
|
# build.py 用了 `from __future__ import annotations`, 需要 python3 >= 3.7。
|
|
# 宿主: python3 在 ~/.local/bin(3.14), /usr/bin/python3 是 3.6(Rocky 8);
|
|
# job 容器(Ubuntu 22.04): /usr/bin/python3 是 3.10。所以不能盲信 PATH 里的第一个。
|
|
# (第一次实测就踩到: 把 /usr/bin 提前 → 用 3.6 跑 build.py → SyntaxError → 语言文件没生成。)
|
|
pick_python() {
|
|
local c
|
|
for c in "$(command -v python3 2>/dev/null)" /usr/local/bin/python3 /usr/bin/python3 "${HOME}/.local/bin/python3"; do
|
|
[[ -n ${c} && -x ${c} ]] || continue
|
|
if "${c}" -c 'import sys; raise SystemExit(0 if sys.version_info >= (3, 7) else 1)' 2>/dev/null; then
|
|
printf '%s' "${c}"
|
|
return 0
|
|
fi
|
|
done
|
|
return 1
|
|
}
|
|
PY="$(pick_python)" || {
|
|
echo "[auto-deploy] 找不到 >= 3.7 的 python3, 中止"
|
|
exit 1
|
|
}
|
|
echo "[auto-deploy] python3: ${PY} ($("${PY}" -V 2>&1))"
|
|
|
|
mkdir -p "${STATE_DIR}"
|
|
TARGET="${1:-$(git -C "${REPO_DIR}" rev-parse HEAD)}"
|
|
PREV="$(cat "${STATE_FILE}" 2>/dev/null || true)"
|
|
|
|
# job 容器里是 root, 会把 clone 里新生成的文件留成 root 所有, 影响宿主上的手工 git 操作。
|
|
# 结束时(无论成功失败)把所有权还回去。
|
|
restore_owner() {
|
|
[[ "$(id -u)" == 0 ]] || return 0
|
|
chown -R "${DEPLOY_OWNER_UID:-1001}:${DEPLOY_OWNER_GID:-1001}" "${REPO_DIR}" 2>/dev/null || true
|
|
}
|
|
trap restore_owner EXIT
|
|
|
|
# workflow 的 concurrency 之外再加一道, 防止手工执行与 CI 撞车
|
|
exec 9>"${STATE_DIR}/lock"
|
|
flock -n 9 || {
|
|
echo "[auto-deploy] 已有部署在跑, 本次退出"
|
|
exit 0
|
|
}
|
|
|
|
echo "[auto-deploy] 目标 ${TARGET} (上次成功部署: ${PREV:-无})"
|
|
cd "${REPO_DIR}"
|
|
|
|
# customization/custom/ 的指纹: 模板、静态页、生成的语言文件都在里面。
|
|
# 这些是 Gitea 启动时加载的, 变了必须重启容器才生效(README §3), 而 `compose up -d`
|
|
# 只在 compose 配置变化时才重建容器 —— 所以自己比指纹, 变了就 restart。
|
|
# ⚠️ 比的是【与上次成功部署的指纹】(.state/custom-hash), 不是 build.py 前后:
|
|
# 后者只能发现语言文件被重新生成, 纯模板改动前后完全一样 → 永远不重启 → 容器继续
|
|
# 用启动时加载的旧模板 → check.sh 断言失败 → 整个部署回滚。2026-09-22 实际踩到
|
|
# (「提问指南」换地址那个提交就这么被回滚了)。
|
|
custom_hash() {
|
|
(cd customization/custom && find . -type f -exec sha256sum {} + | sort | sha256sum | cut -d' ' -f1)
|
|
}
|
|
|
|
# compose 的 bind mount 源目录必须先存在【且属于当前用户】: 源目录不存在时 docker 会
|
|
# 以 root 创建它, 之后 build.py 就写不进去(全新克隆第一次部署时真实踩到, 于是语言文件
|
|
# 生成失败、「工单」回来了)。仓库里 custom/options/.gitkeep 从结构上避免这一点,
|
|
# 这里再兜底检查一次, 失败就说清楚怎么办。
|
|
prepare_custom_dirs() {
|
|
local d
|
|
for d in options public templates; do
|
|
if [[ ! -d customization/custom/${d} ]]; then
|
|
mkdir -p "customization/custom/${d}" 2>/dev/null || {
|
|
echo "[auto-deploy] 无法创建 customization/custom/${d}" >&2
|
|
return 1
|
|
}
|
|
fi
|
|
if [[ ! -w customization/custom/${d} ]]; then
|
|
echo "[auto-deploy] customization/custom/${d} 不可写 —— 很可能是 docker 以 root 创建过它。" >&2
|
|
echo " 删除后重试(宿主上需 sudo; job 容器里是 root): rm -rf customization/custom/${d}" >&2
|
|
return 1
|
|
fi
|
|
done
|
|
}
|
|
|
|
deploy() {
|
|
local force="${1:-}" now last
|
|
prepare_custom_dirs || return 1
|
|
"${PY}" customization/build.py || return 1 # 生成语言文件 + 规范 custom/ 权限
|
|
"${PY}" customization/build.py --check || return 1 # 生成物/权限校验, 不过就中止, 不碰容器
|
|
now="$(custom_hash)"
|
|
(cd deploy && docker compose up -d) || return 1 # 幂等: 只有配置/挂载/镜像变化时才重建
|
|
last="$(cat "${HASH_FILE}" 2>/dev/null || true)"
|
|
if [[ -n ${force} || ${now} != "${last}" ]]; then
|
|
if [[ -n ${force} ]]; then
|
|
echo "[auto-deploy] 回滚路径: 重启 gitea, 让回退后的模板/语言文件生效"
|
|
else
|
|
echo "[auto-deploy] custom/ 与上次成功部署不同, 重启 gitea 使模板/语言文件生效"
|
|
fi
|
|
# 用 restart 而不是 up -d: compose 配置没变时 up -d 不重建容器, 而模板/语言文件
|
|
# 是启动时加载的。restart 还会【重新解析 bind mount】—— 挂载源目录被「删掉再建」
|
|
# (例如某个提交把 public/ 下的文件删光了, git 会顺手删掉空目录)之后, 容器里
|
|
# 仍然挂着旧 inode(一个空目录), 只有重新 start 才会挂到新目录上。
|
|
# 2026-09-22 实际踩到: 线上 /QA/assets/tjhlp/ask-guide.html 变成 404。
|
|
(cd deploy && docker compose restart gitea) || return 1
|
|
else
|
|
echo "[auto-deploy] custom/ 与上次成功部署一致, 不重启"
|
|
fi
|
|
}
|
|
|
|
verify() {
|
|
(cd deploy && ./scripts/verify.sh) || return 1 # 容器健康 + 本机 API + 经 Apache 反代
|
|
if [[ -x ${REPO_DIR}/customization/check.sh ]]; then
|
|
"${REPO_DIR}/customization/check.sh" "${PUBLIC_URL}" || return 1 # 定制断言
|
|
else
|
|
# 回滚到旧版本时那个版本可能还没有这个脚本 —— 那不是失败
|
|
echo "[auto-deploy] (${TARGET} 这个版本没有 customization/check.sh, 跳过定制断言)"
|
|
fi
|
|
}
|
|
|
|
rollback() {
|
|
if [[ -z ${PREV} ]]; then
|
|
echo "[auto-deploy] 没有历史成功版本可回退, 保持现状"
|
|
return 0
|
|
fi
|
|
echo "[auto-deploy] 回滚到 ${PREV}"
|
|
# -f: 旧版本里可能没有 deploy/runner/* 这类文件, 它们在新版本是"未跟踪文件",
|
|
# 会挡住普通 checkout(实测), 这里直接覆盖
|
|
git checkout -f --detach "${PREV}"
|
|
deploy force || true # force: 失败的那次可能已经用新模板重启过容器, 必须再重启回去
|
|
verify || true
|
|
}
|
|
|
|
# 包成一个函数再放进 if: 避免依赖 "&& 列表最后一个命令在 if 条件里是否触发 errexit" 这类细节
|
|
pipeline() { deploy && verify; }
|
|
|
|
if pipeline; then
|
|
echo "${TARGET}" >"${STATE_FILE}"
|
|
custom_hash >"${HASH_FILE}" # 记下本次成功部署的 custom/ 指纹, 供下次比较
|
|
echo "[auto-deploy] ✅ 部署成功 ${TARGET}"
|
|
else
|
|
echo "[auto-deploy] ❌ 部署或验证失败, 开始回滚"
|
|
rollback
|
|
exit 1
|
|
fi
|