SHA256
Compare commits
4
Commits
| Author | SHA256 | Date | |
|---|---|---|---|
|
|
73ce8162aa | ||
|
|
ea3ad2bb31 | ||
|
|
a65970303f | ||
|
|
b60e5e9f1e |
@@ -0,0 +1,40 @@
|
|||||||
|
# main 推送后自动部署到 10.80.42.185/QA。
|
||||||
|
# 逻辑都在 deploy/scripts/auto-deploy.sh 里, 这里只负责"同步到目标提交 + 调脚本"。
|
||||||
|
# 详见 deploy/ci-cd.md。
|
||||||
|
name: deploy
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: deploy-main
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
# 只认 main 的 push 或手动触发; 提交信息含 [skip deploy] 则跳过
|
||||||
|
if: >-
|
||||||
|
github.event_name == 'workflow_dispatch' ||
|
||||||
|
(github.ref == 'refs/heads/main' &&
|
||||||
|
!contains(github.event.head_commit.message, '[skip deploy]'))
|
||||||
|
runs-on: self-hosted
|
||||||
|
timeout-minutes: 30
|
||||||
|
steps:
|
||||||
|
- name: 同步到目标提交
|
||||||
|
run: |
|
||||||
|
set -euo pipefail
|
||||||
|
cd /home/ymy/deploy/tjhlp-gitea
|
||||||
|
git fetch --prune origin
|
||||||
|
# -f: 部署克隆是 CI 独占的; 上一个已部署版本的 deploy/runner/* 等文件在本版本
|
||||||
|
# 若已被跟踪, 会作为"未跟踪文件"挡住普通 checkout(实测)
|
||||||
|
git checkout -f --detach "${{ github.sha }}"
|
||||||
|
git --no-pager log --oneline -1
|
||||||
|
- name: 构建并部署(失败自动回滚)
|
||||||
|
run: |
|
||||||
|
set -euo pipefail
|
||||||
|
./deploy/scripts/auto-deploy.sh
|
||||||
@@ -17,6 +17,10 @@ credentials_*.csv
|
|||||||
# Deployment (docker compose)
|
# Deployment (docker compose)
|
||||||
deploy/.env
|
deploy/.env
|
||||||
deploy/backups/
|
deploy/backups/
|
||||||
|
# CI/CD: 部署状态(上次成功的 SHA)与 runner 的注册凭据/缓存
|
||||||
|
deploy/.state/
|
||||||
|
deploy/runner/.env
|
||||||
|
deploy/runner/data/
|
||||||
|
|
||||||
# Customization
|
# Customization
|
||||||
customization/custom/options/locale/locale_zh-CN.json
|
customization/custom/options/locale/locale_zh-CN.json
|
||||||
|
|||||||
@@ -188,7 +188,15 @@ def main() -> int:
|
|||||||
return 0
|
return 0
|
||||||
|
|
||||||
OUT_PATH.parent.mkdir(parents=True, exist_ok=True)
|
OUT_PATH.parent.mkdir(parents=True, exist_ok=True)
|
||||||
OUT_PATH.write_text(rendered, encoding="utf-8")
|
try:
|
||||||
|
OUT_PATH.write_text(rendered, encoding="utf-8")
|
||||||
|
except PermissionError as exc:
|
||||||
|
raise SystemExit(
|
||||||
|
f"写入失败: {exc}\n"
|
||||||
|
f" 多半是 docker 以 root 创建过这个挂载源目录(bind mount 的源目录不存在时它会这么做),\n"
|
||||||
|
f" 普通用户就写不进去了。删掉再重试: sudo rm -rf {OUT_PATH.parent}\n"
|
||||||
|
f" (仓库里 customization/custom/options/.gitkeep 就是为防止这种情况而存在的)"
|
||||||
|
) from exc
|
||||||
print(f"✓ 已生成 {OUT_PATH}")
|
print(f"✓ 已生成 {OUT_PATH}")
|
||||||
fixed = ensure_readable(CUSTOM_DIR)
|
fixed = ensure_readable(CUSTOM_DIR)
|
||||||
if fixed:
|
if fixed:
|
||||||
|
|||||||
Executable
+119
@@ -0,0 +1,119 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# 定制生效断言 —— 对任意实例跑一遍, 预览与生产共用。
|
||||||
|
# 用法:
|
||||||
|
# customization/check.sh http://127.0.0.1:2081 # 预览
|
||||||
|
# customization/check.sh https://cpp.tongji.sh/QA # 生产(CI 里也调这个)
|
||||||
|
#
|
||||||
|
# 退出码: 0 全通过 / 1 有断言失败 / 2 用法错误。
|
||||||
|
# 只读: 只发 GET, 不改任何东西。
|
||||||
|
set -uo pipefail
|
||||||
|
|
||||||
|
BASE_URL="${1:-}"
|
||||||
|
if [[ -z ${BASE_URL} ]]; then
|
||||||
|
sed -n '2,9p' "$0"
|
||||||
|
exit 2
|
||||||
|
fi
|
||||||
|
BASE_URL="${BASE_URL%/}"
|
||||||
|
ORIGIN="$(printf '%s' "${BASE_URL}" | sed -E 's#(^https?://[^/]+).*#\1#')"
|
||||||
|
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||||
|
|
||||||
|
fail=0
|
||||||
|
ok() { printf ' ✓ %s\n' "$1"; }
|
||||||
|
bad() {
|
||||||
|
printf ' ✗ %s\n' "$1"
|
||||||
|
fail=1
|
||||||
|
}
|
||||||
|
skip() { printf ' – %s\n' "$1"; }
|
||||||
|
|
||||||
|
tmp="$(mktemp -d)"
|
||||||
|
trap 'rm -rf "${tmp}"' EXIT
|
||||||
|
# --noproxy: 验证目标都在内网, 走代理只会把 200 变成 502(见 deploy/README.md 陷阱 5)
|
||||||
|
curl_() { curl -sS --noproxy '*' --max-time 20 "$@"; }
|
||||||
|
|
||||||
|
echo "== 定制检查 ${BASE_URL} =="
|
||||||
|
|
||||||
|
# --- 首页 -------------------------------------------------------------------
|
||||||
|
if ! curl_ -fsS -H 'Accept-Language: zh-CN' "${BASE_URL}/" -o "${tmp}/home.html"; then
|
||||||
|
echo " ✗ 首页打不开(HTTP 非 2xx), 后面不再检查"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
ok "首页可访问"
|
||||||
|
|
||||||
|
grep -q "先搜索,再提问" "${tmp}/home.html" &&
|
||||||
|
ok "首页用的是定制模板 home.tmpl" || bad "首页没有定制模板的内容"
|
||||||
|
grep -q "assets/tjhlp/ask-guide.html" "${tmp}/home.html" &&
|
||||||
|
ok "导航栏/首页已指向课程提问指南" || bad "没找到提问指南链接"
|
||||||
|
! grep -q "painless\|极易搭建\|Easy to install\|Cross-platform" "${tmp}/home.html" &&
|
||||||
|
ok "首页已无 Gitea 功能介绍" || bad "首页仍有 Gitea 功能介绍文案"
|
||||||
|
! grep -qi "powered by" "${tmp}/home.html" &&
|
||||||
|
ok "页脚已无 Powered by Gitea" || bad "页脚仍有 Powered by"
|
||||||
|
! grep -q "docs.gitea.com" "${tmp}/home.html" &&
|
||||||
|
ok "页面已无 docs.gitea.com 外链" || bad "仍有 docs.gitea.com 外链"
|
||||||
|
grep -q 'name="description" content="同济大学高级语言程序设计课程答疑平台"' "${tmp}/home.html" &&
|
||||||
|
ok "meta description 已替换" || bad "meta description 未替换"
|
||||||
|
|
||||||
|
# --- 与课程官网的联动 -------------------------------------------------------
|
||||||
|
grep -q "https://cpp.tongji.sh/Website/" "${tmp}/home.html" &&
|
||||||
|
ok "首页/导航栏已链接课程官网" || bad "首页没有课程官网链接"
|
||||||
|
grep -q "https://cpp.tongji.sh/Website/ask-question/" "${tmp}/home.html" &&
|
||||||
|
ok "首页已链接官网《学会提问》" || bad "首页没有《学会提问》链接"
|
||||||
|
if curl_ -fsS -o "${tmp}/guide.html" "${BASE_URL}/assets/tjhlp/ask-guide.html"; then
|
||||||
|
ok "custom/public 静态页可访问"
|
||||||
|
grep -q "Website/ask-question/" "${tmp}/guide.html" &&
|
||||||
|
ok "站内提问指南已回链官网" || bad "站内提问指南没有官网链接"
|
||||||
|
else
|
||||||
|
bad "提问指南静态页 404"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# --- 中文术语与登录页 -------------------------------------------------------
|
||||||
|
if curl_ -fsS -H 'Accept-Language: zh-CN' "${BASE_URL}/user/login" -o "${tmp}/login.html"; then
|
||||||
|
ok "登录页可访问"
|
||||||
|
grep -q "管理员登录" "${tmp}/login.html" &&
|
||||||
|
ok "登录页有独立的「管理员登录」卡片" || bad "登录页缺少管理员登录卡片"
|
||||||
|
! grep -q "webauthn-error\|signin-passkey" "${tmp}/login.html" &&
|
||||||
|
ok "登录页已无空的通行密钥(WebAuthn)方框" || bad "登录页仍有通行密钥区块"
|
||||||
|
# OIDC 入口: 配了认证源的实例才会渲染 external-login-navigator
|
||||||
|
if grep -q 'id="external-login-navigator"' "${tmp}/login.html"; then
|
||||||
|
href="$(grep -o 'href="[^"]*/user/oauth2/[^"]*"' "${tmp}/login.html" | head -1 |
|
||||||
|
sed -E 's/^href="//; s/"$//')"
|
||||||
|
if [[ -z ${href} ]]; then
|
||||||
|
bad "登录页有认证源区块但没解析出 OAuth2 链接"
|
||||||
|
else
|
||||||
|
code="$(curl_ -o /dev/null -w '%{http_code}' "${ORIGIN}${href}")"
|
||||||
|
# 307 = 认证源注册成功并跳转统一身份认证; 404 = 认证源没注册上(见 README 陷阱 6)
|
||||||
|
[[ ${code} == 307 ]] &&
|
||||||
|
ok "OIDC 入口 ${href} 返回 307(跳转统一身份认证)" ||
|
||||||
|
bad "OIDC 入口返回 ${code}, 期望 307(404 = 认证源没注册上)"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
skip "该实例未配置认证源, 跳过 OIDC 入口检查(预览实例属此情况)"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
bad "登录页打不开"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# 术语: 中文界面里不该再出现「工单」
|
||||||
|
if curl_ -fsS -H 'Accept-Language: zh-CN' -o "${tmp}/issues.html" \
|
||||||
|
"${BASE_URL}/course-team/tjhlp-gitea/issues"; then
|
||||||
|
! grep -q "工单" "${tmp}/issues.html" &&
|
||||||
|
ok "Issue 列表页中文界面已无「工单」" || bad "Issue 列表页仍有「工单」"
|
||||||
|
else
|
||||||
|
skip "读不到 issue 列表页(需要登录?), 跳过「工单」检查"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# --- 仓库内文件(在 checkout 里跑时才有意义) --------------------------------
|
||||||
|
if [[ -d ${ROOT}/issue-templates ]]; then
|
||||||
|
! grep -rq "example.com" "${ROOT}/issue-templates/" &&
|
||||||
|
ok "Issue 模板已无 example.com 占位链接" || bad "Issue 模板里仍有 example.com"
|
||||||
|
fi
|
||||||
|
if [[ -f ${ROOT}/custom/options/locale/locale_zh-CN.json ]]; then
|
||||||
|
! grep -q "工单" "${ROOT}/custom/options/locale/locale_zh-CN.json" &&
|
||||||
|
ok "生成的 zh-CN 语言文件已无「工单」" || bad "语言文件里仍有「工单」"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ ${fail} == 0 ]]; then
|
||||||
|
echo "全部检查通过"
|
||||||
|
else
|
||||||
|
echo "存在检查未通过项"
|
||||||
|
fi
|
||||||
|
exit "${fail}"
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
# 这个文件唯一的用途: 让 git 跟踪住这个空目录。
|
||||||
|
#
|
||||||
|
# customization/custom/ 下的三个子目录会被逐个 bind mount 进容器:
|
||||||
|
# custom/options -> /data/gitea/options
|
||||||
|
# custom/public -> /data/gitea/public
|
||||||
|
# custom/templates-> /data/gitea/templates
|
||||||
|
# 如果 options/ 在全新克隆里不存在(它下面只放生成出来的 locale_zh-CN.json, 而那个文件
|
||||||
|
# 是 gitignore 的), 那么 docker compose 会【以 root 创建】这个挂载源目录 —— 之后
|
||||||
|
# 普通用户跑 customization/build.py 就写不进去:
|
||||||
|
# PermissionError: [Errno 13] Permission denied: .../custom/options/locale
|
||||||
|
# 于是语言文件永远生成不出来, 中文界面退回上游文案(「工单」又回来了)。
|
||||||
|
# 2026-09-13 第一次把生产切到部署克隆时真实踩到。
|
||||||
|
#
|
||||||
|
# 有了这个占位文件, 目录随 checkout 就存在且属于当前用户, 问题从结构上消失。
|
||||||
|
# 真正有内容的是 custom/templates 与 custom/public, 它们不需要占位。
|
||||||
@@ -65,14 +65,14 @@ services:
|
|||||||
GITEA__service__ENABLE_PASSKEY_AUTHENTICATION: "false"
|
GITEA__service__ENABLE_PASSKEY_AUTHENTICATION: "false"
|
||||||
GITEA__mailer__ENABLED: "false"
|
GITEA__mailer__ENABLED: "false"
|
||||||
|
|
||||||
# --- 出站代理 -------------------------------------------------------
|
# --- 出站代理: 显式给值挡掉自动注入, 默认不用代理 ---------------------
|
||||||
# 显式给值, 防止 compose 把宿主 shell 的 http_proxy(本机是 127.0.0.1:7890,
|
# compose 会把宿主 shell 的 http_proxy(本机是 127.0.0.1:7890, 在容器里指向
|
||||||
# 在容器里指向容器自己)自动注入; 生产上这会直接让 OIDC discovery 失败,
|
# 容器自己)自动注入; 生产上这会直接让 OIDC discovery 失败(登录 404)。
|
||||||
# 见 deploy/compose.yaml 同位置注释与 deploy/README.md 陷阱 6。
|
# 容器直连外网本身是通的(实测), 不需要代理; 理由见 deploy/compose.yaml 同位置注释。
|
||||||
HTTP_PROXY: ${GITEA_HTTP_PROXY:-https://cpp.tongji.sh:7890}
|
HTTP_PROXY: ${GITEA_HTTP_PROXY:-}
|
||||||
HTTPS_PROXY: ${GITEA_HTTPS_PROXY:-https://cpp.tongji.sh:7890}
|
HTTPS_PROXY: ${GITEA_HTTPS_PROXY:-}
|
||||||
http_proxy: ${GITEA_HTTP_PROXY:-https://cpp.tongji.sh:7890}
|
http_proxy: ${GITEA_HTTP_PROXY:-}
|
||||||
https_proxy: ${GITEA_HTTPS_PROXY:-https://cpp.tongji.sh:7890}
|
https_proxy: ${GITEA_HTTPS_PROXY:-}
|
||||||
NO_PROXY: ${GITEA_NO_PROXY:-localhost,127.0.0.1,::1,10.80.42.185,.local,.internal}
|
NO_PROXY: ${GITEA_NO_PROXY:-localhost,127.0.0.1,::1,10.80.42.185,.local,.internal}
|
||||||
no_proxy: ${GITEA_NO_PROXY:-localhost,127.0.0.1,::1,10.80.42.185,.local,.internal}
|
no_proxy: ${GITEA_NO_PROXY:-localhost,127.0.0.1,::1,10.80.42.185,.local,.internal}
|
||||||
|
|
||||||
|
|||||||
+7
-4
@@ -30,10 +30,13 @@ GITEA_CUSTOM_DIR=../customization/custom
|
|||||||
|
|
||||||
# -----------------------------------------------------------------------------
|
# -----------------------------------------------------------------------------
|
||||||
# 容器出站代理(见 compose.yaml 同段落注释 / README 陷阱 6)
|
# 容器出站代理(见 compose.yaml 同段落注释 / README 陷阱 6)
|
||||||
# compose 会把「运行 compose 的 shell」里的 http_proxy 自动注入容器。本机登录 shell
|
# 默认: compose.yaml 里显式写成空值, 即容器内【不用代理】。这不是省事, 是有意的:
|
||||||
# 里的值是 127.0.0.1:7890 —— 那个地址在容器里是容器自己, 一旦被注入, Gitea 启动时
|
# * compose 会把「运行 compose 的 shell」里的 http_proxy 自动注入容器, 而本机登录
|
||||||
# OIDC discovery 直接失败, 统一身份认证登录 404。所以 compose.yaml 里显式写了默认值,
|
# shell 里是 127.0.0.1:7890 —— 那个地址在容器里是容器自己, 一旦被注入, Gitea
|
||||||
# 下面这三行一般不用开; 需要改代理/彻底不用代理时再取消注释并修改(置空即不用)。
|
# 启动时 OIDC discovery 就失败, 统一身份认证登录 404; 显式给空值能挡住注入。
|
||||||
|
# * 容器【直连外网是通的】(实测 dl.gitea.com / api.github.com / codeload 都能直连),
|
||||||
|
# 平台功能相关的出站(OIDC)也在内网直连, 所以不需要代理。
|
||||||
|
# 将来若确实要给容器配代理, 必须是【容器可达】的地址(别写 127.0.0.1, 那是容器自己):
|
||||||
# -----------------------------------------------------------------------------
|
# -----------------------------------------------------------------------------
|
||||||
#GITEA_HTTP_PROXY=https://cpp.tongji.sh:7890
|
#GITEA_HTTP_PROXY=https://cpp.tongji.sh:7890
|
||||||
#GITEA_HTTPS_PROXY=https://cpp.tongji.sh:7890
|
#GITEA_HTTPS_PROXY=https://cpp.tongji.sh:7890
|
||||||
|
|||||||
+49
-3
@@ -35,6 +35,7 @@
|
|||||||
| **恢复**(含演练) | §6 | `sudo ./scripts/restore.sh <时间戳> --apply` |
|
| **恢复**(含演练) | §6 | `sudo ./scripts/restore.sh <时间戳> --apply` |
|
||||||
| **升级** Gitea / PostgreSQL | §7 | 备份 → 改 `.env` → `up -d` |
|
| **升级** Gitea / PostgreSQL | §7 | 备份 → 改 `.env` → `up -d` |
|
||||||
| 改首页 / 中文术语 / 去 Gitea 化 | [`../customization/README.md`](../customization/README.md) | `python3 customization/build.py` → `docker compose restart gitea` |
|
| 改首页 / 中文术语 / 去 Gitea 化 | [`../customization/README.md`](../customization/README.md) | `python3 customization/build.py` → `docker compose restart gitea` |
|
||||||
|
| main 推送后自动部署(方案) | [`ci-cd.md`](ci-cd.md) | Gitea Actions + 宿主 act_runner(host 模式) |
|
||||||
| 出问题了 | §12 | — |
|
| 出问题了 | §12 | — |
|
||||||
| 退回二进制部署 | §9 | `docker compose down && sudo systemctl start gitea` |
|
| 退回二进制部署 | §9 | `docker compose down && sudo systemctl start gitea` |
|
||||||
|
|
||||||
@@ -159,14 +160,59 @@
|
|||||||
> `/QA/user/oauth2/...` 返回 **404**, 统一身份认证**完全无法登录**。
|
> `/QA/user/oauth2/...` 返回 **404**, 统一身份认证**完全无法登录**。
|
||||||
> 这个坑很隐蔽: 容器是健康的、健康检查 `200`、登录页 `200`, 只有真正点登录才炸。
|
> 这个坑很隐蔽: 容器是健康的、健康检查 `200`、登录页 `200`, 只有真正点登录才炸。
|
||||||
>
|
>
|
||||||
> `compose.yaml` 现在**显式**给出这四个变量(默认 = 改造前宿主机上的代理设置,
|
> `compose.yaml` 现在**显式**给出这几个变量、且默认**空值**(= 容器内不用代理),
|
||||||
> 且 `NO_PROXY` 含 `10.80.42.185` 让 OIDC 走直连), 显式赋值可以挡住自动注入。
|
> 显式赋值可以挡住自动注入。**默认不用代理的依据**(2026-09-13 实测):
|
||||||
> 改代理见 `.env.example` 的同名段落。**每次 `up -d` 后建议验一次**:
|
> * 容器**直连外网是通的**: `dl.gitea.com`、`api.github.com`、`codeload.github.com`
|
||||||
|
> 在容器里直接 curl 分别是 `200/200/301`(`github.com` 主站直连会超时, 但平台不依赖它);
|
||||||
|
> * 与功能相关的出站只有 OIDC, 目标是 `10.80.42.185`, 容器内直连即 `200`;
|
||||||
|
> * 宿主 `7890` 那个代理是 **ssh 转发的开发用代理**, `ss -ltn` 显示只监听
|
||||||
|
> `127.0.0.1:7890`/`[::1]:7890` —— 在容器里 `127.0.0.1` 是容器自己,
|
||||||
|
> `10.80.42.185:7890` 也不可达(实测 `curl -x` 直接 `Could not connect`),
|
||||||
|
> 所以这个代理配进容器只会让出站先绕一圈再失败。
|
||||||
|
>
|
||||||
|
> 将来真要给容器配代理, 必须是**容器可达**的地址(把隧道绑到 LAN 口, 或让容器用
|
||||||
|
> host 网络), 再在 `.env` 里给 `GITEA_HTTP_PROXY`(见 `.env.example`)。
|
||||||
|
> **每次 `up -d` 后建议验一次** OIDC 入口是否还通:
|
||||||
> ```bash
|
> ```bash
|
||||||
> curl -sS --noproxy '*' -o /dev/null -w '%{http_code} %{redirect_url}\n' \
|
> curl -sS --noproxy '*' -o /dev/null -w '%{http_code} %{redirect_url}\n' \
|
||||||
> 'http://127.0.0.1:2080/user/oauth2/%E9%AB%98%E7%A8%8B%E7%BB%9F%E4%B8%80%E8%BA%AB%E4%BB%BD%E8%AE%A4%E8%AF%81'
|
> 'http://127.0.0.1:2080/user/oauth2/%E9%AB%98%E7%A8%8B%E7%BB%9F%E4%B8%80%E8%BA%AB%E4%BB%BD%E8%AE%A4%E8%AF%81'
|
||||||
> # 期望: 307 + Location: https://cpp.tongji.sh/oidc/auth?... (404 = 认证源没注册上)
|
> # 期望: 307 + Location: https://cpp.tongji.sh/oidc/auth?... (404 = 认证源没注册上)
|
||||||
> ```
|
> ```
|
||||||
|
>
|
||||||
|
> **⚠️ 7. 全新克隆 + compose: docker 会以 root 创建不存在的挂载源目录。**
|
||||||
|
> `compose.yaml` 把 `customization/custom/{options,public,templates}` 逐个挂进容器。
|
||||||
|
> 其中 `options/` 里只有生成出来的 `locale_zh-CN.json`, 而它是 gitignore 的 —— 于是
|
||||||
|
> 全新克隆里这个目录不存在, **docker 会以 root 创建它**, 之后普通用户跑
|
||||||
|
> `customization/build.py` 就写不进去:
|
||||||
|
> ```
|
||||||
|
> PermissionError: [Errno 13] Permission denied: .../custom/options/locale
|
||||||
|
> ```
|
||||||
|
> 后果不是报错那么明显: 语言文件生成失败 → 中文界面退回上游文案(「工单」又回来了),
|
||||||
|
> 而首页/登录页看起来一切正常。2026-09-13 第一次把生产切到部署克隆(CI 用的那份)时踩到。
|
||||||
|
>
|
||||||
|
> 现在有两道防线: ①仓库里 `customization/custom/options/.gitkeep` 让目录随 checkout 就存在
|
||||||
|
> 且属于当前用户; ②`deploy/scripts/auto-deploy.sh` 在部署前检查三个目录存在且**可写**,
|
||||||
|
> 不满足就明确报错。若已经中招:
|
||||||
|
> ```bash
|
||||||
|
> sudo rm -rf customization/custom/options # 空的 root 目录, 删掉即可
|
||||||
|
> ```
|
||||||
|
>
|
||||||
|
> **⚠️ 8. act_runner 的 job 容器不要自己挂 `docker.sock`。**
|
||||||
|
> act_runner 会把 docker daemon socket **自动**挂进 job 容器(`container.docker_host` 的默认
|
||||||
|
> 行为); 再在 `deploy/runner/config.yaml` 的 `container.options` 里挂一次, 第一次真实部署
|
||||||
|
> 就会以这个错误告终:
|
||||||
|
> ```
|
||||||
|
> failed to create container: 'Duplicate mount point: /var/run/docker.sock'
|
||||||
|
> ```
|
||||||
|
> 2026-09-13 用 `act_runner exec` 预演 job 时提前发现。`container.options` 里只保留
|
||||||
|
> 部署克隆(同路径)、宿主 docker CLI、compose 插件这三项。
|
||||||
|
>
|
||||||
|
> **⚠️ 9. 宿主 `/usr/bin/python3` 是 3.6, 别让它排到 PATH 前面。**
|
||||||
|
> `customization/build.py` 用了 `from __future__ import annotations`, 需要 ≥3.7。
|
||||||
|
> 宿主上正确的解释器是 `~/.local/bin/python3`(3.14), 但 `/usr/bin/python3` 是 Rocky 8 的
|
||||||
|
> 3.6 —— 只要 PATH 被改成 `/usr/bin` 优先, 就会看到
|
||||||
|
> `SyntaxError: future feature annotations is not defined`, 而且**语言文件静默地不再更新**。
|
||||||
|
> `auto-deploy.sh` 现在自己挑一个 ≥3.7 的解释器(并用它跑 build.py), 不依赖 PATH 顺序。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
+503
@@ -0,0 +1,503 @@
|
|||||||
|
# CI/CD:main 自动部署(Gitea Actions 方案)
|
||||||
|
|
||||||
|
> **状态:已落地并本地验证通过(2026-09-13),只差一次 `git push`。**
|
||||||
|
> runner 已注册、部署克隆已建、生产已切到部署克隆、整条部署路径(含真实 job 容器)
|
||||||
|
> 已在本机预演通过;推送 `main` 后第一次 CI 运行即接管。**全程不需要 root。**
|
||||||
|
>
|
||||||
|
> 本文标注 **[实测]** 的结论都是 2026-09-13 在本机跑出来的,命令写在对应位置,可复现。
|
||||||
|
> 当前进度与剩余动作见 §0.1。
|
||||||
|
> 相关文档:[deploy/README.md](README.md)(部署与陷阱,含本次踩到的 3 个坑)、
|
||||||
|
> [customization/README.md](../customization/README.md)(定制机制与预览)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 0. 目标
|
||||||
|
|
||||||
|
`course-team/tjhlp-gitea` 的 `main` 一有推送,就自动把平台更新到那个提交:
|
||||||
|
构建定制产物 → 重建容器 → 跑验证 → 失败自动回滚。人工只负责 review 和 push。
|
||||||
|
|
||||||
|
不在本方案范围内:Gitea 版本升级(要备份 + 数据库迁移,仍走 [README §7](README.md) 人工流程)、
|
||||||
|
`issue-templates` 重新推送(运营操作)、官网仓库(`Website`)的部署(那是 GitHub Actions 的事)。
|
||||||
|
|
||||||
|
### 0.1 落地现状与剩余动作(2026-09-13)
|
||||||
|
|
||||||
|
已完成并验证:
|
||||||
|
|
||||||
|
| 项 | 证据 |
|
||||||
|
|---|---|
|
||||||
|
| 部署克隆 `/home/ymy/deploy/tjhlp-gitea`(`origin` = 本机裸仓库,免凭据) | `git remote -v`;`deploy/.env` 600;工作树干净 |
|
||||||
|
| runner 已注册 | `action_runner` 表:`tjhlp-gitea-1 / v0.6.1 / ["self-hosted"]`;日志 `declare successfully` |
|
||||||
|
| 生产已切到部署克隆 | `docker inspect gitea` 的三个挂载源都指向 `/home/ymy/deploy/tjhlp-gitea/...` |
|
||||||
|
| 部署脚本本机跑通(回滚被真实触发过两次) | `auto-deploy.sh` → `build.py` → `up -d` → `verify.sh` + `check.sh` → `✅ 部署成功`;`deploy/.state/last-deployed` 记 SHA |
|
||||||
|
| job 容器路径 | `act_runner exec` 预演:`uid=0 / Python 3.10.12 / git 2.55 / docker server 29.8.0 / compose v5.5.1`,部署克隆可见,`loopback-api=200 apache=200`,`🏁 Job succeeded` |
|
||||||
|
|
||||||
|
这次落地中发现并修掉的问题(细节见 [README](README.md) 陷阱 7–9):
|
||||||
|
|
||||||
|
1. 全新克隆里 `customization/custom/options/` 不存在 → docker 以 root 创建这个挂载源目录 →
|
||||||
|
`build.py` 写不进去 → **语言文件生成失败、「工单」回归**(首页/登录页却看着正常)。
|
||||||
|
修法:`.gitkeep` 让目录随 checkout 存在 + 部署前可写性检查。
|
||||||
|
2. `container.options` 里自己挂 `docker.sock` 与 act_runner 的自动挂载冲突
|
||||||
|
(`Duplicate mount point`),第一次真实部署必然失败。修法:去掉显式挂载。
|
||||||
|
3. 宿主 `/usr/bin/python3` 是 **3.6**,PATH 顺序一变 `build.py` 就 `SyntaxError`,而且语言
|
||||||
|
文件会**静默地**不再更新。修法:脚本自己挑 ≥3.7 的解释器并用它跑 build.py。
|
||||||
|
|
||||||
|
剩余动作:
|
||||||
|
|
||||||
|
1. **你来 `git push`**(本地有 4 个未推送提交)——推送即触发第一次 CI 运行;由于要部署的
|
||||||
|
版本已经在本机部署过,这次应当是"无变化"的快速通过。
|
||||||
|
2. 用一个测试 fork 发 PR,确认 fork PR 的 workflow 审批行为(§9.1);确认前不要把仓库
|
||||||
|
开放给不可信贡献者。
|
||||||
|
3. 给 `main` 加分支保护(§4.4)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. 现状与约束 **[实测]**
|
||||||
|
|
||||||
|
| 项 | 实测值 | 对方案的影响 |
|
||||||
|
|---|---|---|
|
||||||
|
| Gitea | 1.27.3;Actions 默认开启(`modules/setting/actions.go` 里 `Enabled: true`),仓库页有 `/actions` | 不用改配置就能用 |
|
||||||
|
| 已注册 runner | **无**(`action_runner` 表空) | 要自己起一个 |
|
||||||
|
| `act_runner` 镜像 | `docker pull gitea/act_runner:latest` 成功:**arm64, v0.6.1, 69.3MB** | runner 用容器跑,**不需要 root** |
|
||||||
|
| job 镜像 | `docker.gitea.com/runner-images:ubuntu-22.04`(Gitea 官方, arm64 可用)、`catthehacker/ubuntu:act-22.04`(arm64, 压缩约 512MB)、`node:20-bookworm-slim`、`rockylinux:8` 的 manifest 都能取到 | 有现成镜像可跑容器模式 job |
|
||||||
|
| 宿主出网 | 国内直连 `200`;境外经代理 `200`(`https://dl.gitea.com/...`、`https://github.com` 经 `127.0.0.1:7890` 均 `200`) | 正常联网,不是离线环境 |
|
||||||
|
| 容器出网 | 容器内直连:`dl.gitea.com` `200`、`api.github.com` `200`、`codeload.github.com` `301`;**`github.com` 主站直连 12s 超时** | `uses: actions/checkout` 这类动作走 codeload/api 通常可以;主站要通就得给镜像或 `github_mirror` |
|
||||||
|
| docker daemon 代理 | `/etc/systemd/system/docker.service.d/http-proxy.conf` 里 `HTTP(S)_PROXY=http://127.0.0.1:7890` | 镜像拉取走代理,正常 |
|
||||||
|
| `ymy` 的组 | `ymy, wheel, git(982), docker(980)` | 容器方案不需要 sudo;host 模式才需要 |
|
||||||
|
| 裸仓库 | `/srv/gitea/git/repositories/course-team/tjhlp-gitea.git`,`drwxr-xr-x git:git`,`git ls-remote` 通(需 `safe.directory`,见 §4.1) | CI 可以**免凭据**取代码 |
|
||||||
|
| 现成积木 | `deploy/scripts/{verify,backup,restore}.sh`、`customization/build.py`、`preview.sh check` | 直接复用 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. 方案总览
|
||||||
|
|
||||||
|
### 2.1 架构
|
||||||
|
|
||||||
|
```text
|
||||||
|
开发者 push main
|
||||||
|
│
|
||||||
|
▼
|
||||||
|
Gitea (10.80.42.185/QA) ── 调度 workflow ──► act_runner(docker compose 服务, 容器)
|
||||||
|
▲ │ 拉起 job 容器
|
||||||
|
│ 日志/状态显示在仓库 Actions 标签 ▼
|
||||||
|
└──────────────────── job 容器(network: host)
|
||||||
|
├─ 挂 docker.sock → 可执行 docker compose
|
||||||
|
├─ 挂 /home/ymy/deploy(同路径)→ 部署克隆
|
||||||
|
└─ 跑 auto-deploy.sh: build.py → up -d → verify → 失败回滚
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2.2 runner 形态:容器(推荐)vs 宿主二进制
|
||||||
|
|
||||||
|
| | **A. 容器(推荐)** | B. 宿主二进制 + host 模式 |
|
||||||
|
|---|---|---|
|
||||||
|
| 安装 | `docker compose up -d`(镜像实测可拉) | 下载二进制 + **需要 sudo** 装 systemd 单元 |
|
||||||
|
| job 执行 | job 容器(镜像由 label 决定) | 直接在宿主以 `ymy` 执行 |
|
||||||
|
| 工具依赖 | 靠 job 镜像(要确认镜像里有 git/python3/docker CLI) | 宿主现成,最省事 |
|
||||||
|
| 挂载 | 靠 `container.options` 把 docker.sock 与部署克隆按**同路径**挂进 job 容器 | 无 |
|
||||||
|
| 开机自启 | compose 的 `restart: unless-stopped` | systemd |
|
||||||
|
| 结论 | **默认选它**:不需要 root、标准、日志清晰 | 想少一层容器、且你愿意跑一次 sudo 时选它 |
|
||||||
|
|
||||||
|
act_runner v0.6.1 自己的 `generate-config` 输出里明确写了两种 label 写法,两个事实由此确认:
|
||||||
|
|
||||||
|
```text
|
||||||
|
# Like: "macos-arm64:host" or "ubuntu-latest:docker://docker.gitea.com/runner-images:ubuntu-latest"
|
||||||
|
labels:
|
||||||
|
- "ubuntu-latest:docker://docker.gitea.com/runner-images:ubuntu-latest"
|
||||||
|
container:
|
||||||
|
# Could be host, bridge or the name of a custom network.
|
||||||
|
network: ""
|
||||||
|
```
|
||||||
|
|
||||||
|
即 **`:host` 支持**(备选 B 可用)、**`container.network: host` 支持**(方案 A 里让 job 容器
|
||||||
|
能和宿主共用回环,`verify.sh` 里 `127.0.0.1:2080` 的检查才继续有效)。
|
||||||
|
|
||||||
|
### 2.3 触发与门禁
|
||||||
|
|
||||||
|
- 触发:`push` 到 `main`,外加 `workflow_dispatch`(落地初期先只手动触发);
|
||||||
|
- 跳过:提交信息含 `[skip deploy]` 不部署(与 Gitea 自带的 `[skip ci]` 同风格);
|
||||||
|
- 串行:workflow 的 `concurrency` + 脚本里的 `flock` 双保险;
|
||||||
|
- 只认 `main`:job 级 `if` 卡死分支,PR/其它分支即使跑工作流也不碰生产。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. 组件清单
|
||||||
|
|
||||||
|
| 组件 | 位置 | 谁维护 |
|
||||||
|
|---|---|---|
|
||||||
|
| 部署克隆 | `/home/ymy/deploy/tjhlp-gitea` | 本方案新建(§4.1) |
|
||||||
|
| 部署凭据 | `deploy/.env`(`chmod 600`,已 gitignore) | 从现有部署复制 |
|
||||||
|
| 部署状态 | `deploy/.state/last-deployed`(上次成功的 SHA) | 脚本写,加进 `.gitignore` |
|
||||||
|
| runner | `deploy/runner/compose.yaml` + `deploy/runner/config.yaml` + `deploy/runner/data/`(gitignore) | 新增到仓库 |
|
||||||
|
| 工作流 | `.gitea/workflows/deploy.yml` | 新增到仓库(§5.1) |
|
||||||
|
| 部署脚本 | `deploy/scripts/auto-deploy.sh` | 新增到仓库(§5.2) |
|
||||||
|
| 定制断言 | `customization/check.sh <base-url>` | 新增到仓库(§5.3) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. 落地步骤
|
||||||
|
|
||||||
|
### 4.1 部署克隆(不需要 root)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 让 ymy 能读 Gitea 的裸仓库。
|
||||||
|
# ★ 实测: git -c safe.directory=... 对本机 git 无效, 必须写进配置文件才生效。
|
||||||
|
git config --global --add safe.directory \
|
||||||
|
/srv/gitea/git/repositories/course-team/tjhlp-gitea.git
|
||||||
|
|
||||||
|
# 从裸仓库克隆: origin 就指向本机裸仓库, CI 全程不需要任何 git token
|
||||||
|
git clone /srv/gitea/git/repositories/course-team/tjhlp-gitea.git \
|
||||||
|
/home/ymy/deploy/tjhlp-gitea
|
||||||
|
|
||||||
|
cd /home/ymy/deploy/tjhlp-gitea
|
||||||
|
cp /home/ymy/tjhlp-gitea/deploy/.env deploy/.env # 部署密钥, 别提交
|
||||||
|
chmod 600 deploy/.env
|
||||||
|
mkdir -p deploy/.state
|
||||||
|
```
|
||||||
|
|
||||||
|
> ⚠️ 从此 `deploy/.env` 有**两份**(dev 克隆一份、部署克隆一份)。约定:**部署克隆那份是权威**,
|
||||||
|
> dev 克隆那份只服务本地预览;改密钥时两边同步。
|
||||||
|
>
|
||||||
|
> ⚠️ 切换后**不要再从 dev 克隆 `up -d`**:compose 项目名同为 `gitea`(同一组容器),但 bind mount
|
||||||
|
> 的源路径按 compose 文件所在目录解析,两边会互相覆盖。dev 克隆只留开发与预览。
|
||||||
|
|
||||||
|
### 4.2 起 runner 并注册(不需要 root)
|
||||||
|
|
||||||
|
先在 Gitea 上拿一个**仓库级**注册令牌(API 实测存在:
|
||||||
|
`POST /api/v1/repos/{owner}/{repo}/actions/runners/registration-token`;
|
||||||
|
也可以在 仓库 → Settings → Actions → Runners 页面点按钮):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -sS -X POST \
|
||||||
|
-H "Authorization: token <你的 PAT, 需要 repo 权限>" \
|
||||||
|
"https://cpp.tongji.sh/QA/api/v1/repos/course-team/tjhlp-gitea/actions/runners/registration-token" \
|
||||||
|
| python3 -c 'import json,sys; print(json.load(sys.stdin)["token"])'
|
||||||
|
```
|
||||||
|
|
||||||
|
把令牌写进 `deploy/runner/.env`(gitignore),然后:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /home/ymy/deploy/tjhlp-gitea/deploy/runner
|
||||||
|
docker compose up -d
|
||||||
|
docker compose logs -f runner # 看到 "runner registered successfully" 即可
|
||||||
|
```
|
||||||
|
|
||||||
|
仓库 → Settings → Actions → Runners 里应出现 `tjhlp-gitea-1`(Idle)。注册令牌用完即弃:
|
||||||
|
注册结果存在 `deploy/runner/data/.runner`,之后 runner 用它通信,不会过期。
|
||||||
|
|
||||||
|
`deploy/runner/compose.yaml`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: gitea-runner
|
||||||
|
services:
|
||||||
|
runner:
|
||||||
|
image: gitea/act_runner:latest # 实测 arm64 / v0.6.1 / 可拉取
|
||||||
|
restart: unless-stopped
|
||||||
|
environment:
|
||||||
|
# 这组变量名来自镜像里的 /usr/local/bin/run.sh(实测)
|
||||||
|
GITEA_INSTANCE_URL: https://cpp.tongji.sh/QA
|
||||||
|
GITEA_RUNNER_REGISTRATION_TOKEN: ${RUNNER_REGISTRATION_TOKEN:?先按 §4.2 拿令牌}
|
||||||
|
GITEA_RUNNER_NAME: tjhlp-gitea-1
|
||||||
|
# 不要在 env 里设 GITEA_RUNNER_LABELS: act_runner 会警告
|
||||||
|
# "Labels from command will be ignored, use labels defined in config file.",
|
||||||
|
# label 以 config.yaml 为准(实测)
|
||||||
|
CONFIG_FILE: /config/config.yaml
|
||||||
|
volumes:
|
||||||
|
- /var/run/docker.sock:/var/run/docker.sock # runner 用它拉起 job 容器
|
||||||
|
- ./data:/data # 注册凭据 (.runner)
|
||||||
|
- ./config.yaml:/config/config.yaml:ro
|
||||||
|
```
|
||||||
|
|
||||||
|
`deploy/runner/config.yaml`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
log:
|
||||||
|
level: info
|
||||||
|
runner:
|
||||||
|
file: /data/.runner
|
||||||
|
capacity: 1 # 部署必须串行, 一个 job 一个 job 地跑
|
||||||
|
timeout: 30m
|
||||||
|
labels:
|
||||||
|
# job 跑在容器里; 镜像换成本地已有/更小的亦可(如 catthehacker/ubuntu:act-22.04)
|
||||||
|
- "self-hosted:docker://docker.gitea.com/runner-images:ubuntu-22.04"
|
||||||
|
container:
|
||||||
|
network: host # job 容器与宿主共用网络: 127.0.0.1:2080 与 10.80.42.185 都能直连
|
||||||
|
options: >-
|
||||||
|
--volume /home/ymy/deploy:/home/ymy/deploy
|
||||||
|
--volume /usr/bin/docker:/usr/bin/docker:ro
|
||||||
|
--volume /usr/libexec/docker/cli-plugins:/usr/libexec/docker/cli-plugins:ro
|
||||||
|
force_pull: false # 镜像已有就别每次拉
|
||||||
|
# ★ 不要挂 /var/run/docker.sock: act_runner 会自动挂, 重复挂会
|
||||||
|
# "Duplicate mount point: /var/run/docker.sock" 直接失败(实测)
|
||||||
|
cache:
|
||||||
|
enabled: true
|
||||||
|
```
|
||||||
|
|
||||||
|
三处关键点:
|
||||||
|
|
||||||
|
- `--volume /home/ymy/deploy:/home/ymy/deploy` **必须同路径**:`docker compose` 在 job 容器里
|
||||||
|
把相对挂载解析成绝对路径后交给宿主 daemon 执行,路径不一致会挂到空目录;
|
||||||
|
- 挂 `/usr/bin/docker` 与 `cli-plugins` 是为了不依赖 job 镜像里有没有 docker CLI / compose 插件
|
||||||
|
(宿主是 glibc,Ubuntu 镜像能用;落地时若镜像自带,也可以去掉这两行);
|
||||||
|
- `docker.sock` 会被 act_runner 自动挂进 job 容器(`container.docker_host` 默认行为),
|
||||||
|
上面仍显式挂一次更直观。
|
||||||
|
|
||||||
|
### 4.3 试运行(手动触发)
|
||||||
|
|
||||||
|
1. 提交 §5 的文件,workflow 的 `on:` **先只留 `workflow_dispatch`**(没有 runner 时 push 触发
|
||||||
|
会一直挂在"等待 runner");
|
||||||
|
2. 仓库 → Actions → deploy → **Run workflow**(选 `main`);
|
||||||
|
3. 盯日志确认:构建 → `up -d` → 验证全过 → Actions 绿色;
|
||||||
|
4. 故意推一个坏提交(例如把 `overrides/locale_zh-CN.json` 的键写错)验证**回滚路径**真的生效。
|
||||||
|
|
||||||
|
### 4.4 打开自动触发 + 加保护
|
||||||
|
|
||||||
|
1. 把 `push: branches: [main]` 加回 workflow;
|
||||||
|
2. 仓库 → Settings → Branches → 给 `main` 加保护:**要求 PR + 至少 1 个 review**;
|
||||||
|
3. `deploy/README.md` 的快速索引里已有一行指向本文档。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. 流水线内容
|
||||||
|
|
||||||
|
### 5.1 `.gitea/workflows/deploy.yml`
|
||||||
|
|
||||||
|
刻意做得很薄:workflow 只做"同步到目标提交 + 调仓库里的部署脚本",逻辑都在
|
||||||
|
`auto-deploy.sh`(可版本化、可手工跑、可本地调试)。
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: deploy
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
workflow_dispatch: # 阶段 4.3 只留这个
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: deploy-main
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
# 只认 main 的 push 或手动触发; 提交信息含 [skip deploy] 则跳过
|
||||||
|
if: >-
|
||||||
|
github.event_name == 'workflow_dispatch' ||
|
||||||
|
(github.ref == 'refs/heads/main' &&
|
||||||
|
!contains(github.event.head_commit.message, '[skip deploy]'))
|
||||||
|
runs-on: self-hosted
|
||||||
|
timeout-minutes: 30
|
||||||
|
steps:
|
||||||
|
- name: 同步到目标提交
|
||||||
|
run: |
|
||||||
|
set -euo pipefail
|
||||||
|
cd /home/ymy/deploy/tjhlp-gitea
|
||||||
|
git fetch --prune origin
|
||||||
|
git checkout --detach "${{ github.sha }}"
|
||||||
|
- name: 构建并部署(失败自动回滚)
|
||||||
|
run: |
|
||||||
|
set -euo pipefail
|
||||||
|
./deploy/scripts/auto-deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
**不写 `uses:`** 的理由:本项目不需要——代码从本机裸仓库取、部署逻辑是仓库里的脚本,
|
||||||
|
省掉每次运行下载 action 的开销,也避开 `github.com` 主站直连超时带来的不确定性。
|
||||||
|
将来若要做 PR 检查(lint/pytest)想用现成 action,两条路:给 runner 容器配容器可达的代理,
|
||||||
|
或在 runner 的 `config.yaml` 里设置 `github_mirror`(v0.6.1 的配置注释里就是为"特殊网络环境"
|
||||||
|
准备的),把 `uses:` 的 github 地址替换成镜像。
|
||||||
|
|
||||||
|
### 5.2 `deploy/scripts/auto-deploy.sh`
|
||||||
|
|
||||||
|
```bash
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
# main 自动部署。由 .gitea/workflows/deploy.yml 调用, 也可手工执行:
|
||||||
|
# ./auto-deploy.sh # 部署当前 checkout
|
||||||
|
# ./auto-deploy.sh <sha> # 部署指定提交
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
REPO_DIR=$(cd "$(dirname "$0")/../.." && pwd)
|
||||||
|
STATE_DIR="${REPO_DIR}/deploy/.state"
|
||||||
|
STATE_FILE="${STATE_DIR}/last-deployed"
|
||||||
|
PUBLIC_URL="${GITEA_PUBLIC_URL:-http://10.80.42.185/QA}"
|
||||||
|
|
||||||
|
# 本机回环验证不能走代理, 否则会拿 502 冒充故障(见 README 陷阱 5)
|
||||||
|
unset http_proxy https_proxy HTTP_PROXY HTTPS_PROXY
|
||||||
|
export no_proxy='*' NO_PROXY='*'
|
||||||
|
# 既能在 job 容器里跑, 也能在宿主上跑; 不要写死某台机器的 pyenv 路径
|
||||||
|
export PATH="/usr/local/bin:/usr/bin:/bin:${PATH}"
|
||||||
|
|
||||||
|
mkdir -p "$STATE_DIR"
|
||||||
|
TARGET=${1:-$(git -C "$REPO_DIR" rev-parse HEAD)}
|
||||||
|
PREV=$(cat "$STATE_FILE" 2>/dev/null || true)
|
||||||
|
|
||||||
|
exec 9>"${STATE_DIR}/lock" # workflow 的 concurrency 之外再加一道
|
||||||
|
flock -n 9 || { echo "[auto-deploy] 已有部署在跑, 退出"; exit 0; }
|
||||||
|
|
||||||
|
echo "[auto-deploy] 目标 ${TARGET} (上次成功: ${PREV:-无})"
|
||||||
|
cd "$REPO_DIR"
|
||||||
|
|
||||||
|
deploy() {
|
||||||
|
python3 customization/build.py # 生成语言文件 + 规范 custom/ 权限(容器用户要能读)
|
||||||
|
python3 customization/build.py --check # 生成物/权限校验, 不过就中止, 不碰容器
|
||||||
|
( cd deploy && docker compose up -d ) # 幂等: 只有配置/镜像变化时才重建
|
||||||
|
}
|
||||||
|
|
||||||
|
verify() {
|
||||||
|
( cd deploy && ./scripts/verify.sh ) # 容器健康 + 本机 API + 经 Apache 反代
|
||||||
|
customization/check.sh "$PUBLIC_URL" # 定制断言: 首页/登录页/OIDC/术语(见 5.3)
|
||||||
|
}
|
||||||
|
|
||||||
|
rollback() {
|
||||||
|
[[ -z "${PREV}" ]] && { echo "[auto-deploy] 无历史版本可回退, 保持现状"; return 0; }
|
||||||
|
echo "[auto-deploy] 回滚到 ${PREV}"
|
||||||
|
git checkout --detach "$PREV"
|
||||||
|
deploy || true
|
||||||
|
verify || true
|
||||||
|
}
|
||||||
|
|
||||||
|
if deploy && verify; then
|
||||||
|
echo "$TARGET" > "$STATE_FILE"
|
||||||
|
echo "[auto-deploy] ✅ 部署成功 ${TARGET}"
|
||||||
|
else
|
||||||
|
echo "[auto-deploy] ❌ 部署或验证失败, 开始回滚"
|
||||||
|
rollback
|
||||||
|
exit 1 # 让这次 Actions 运行标红, 完整日志留在 UI 里
|
||||||
|
fi
|
||||||
|
```
|
||||||
|
|
||||||
|
落库前的两个小动作:`.gitignore` 加 `deploy/.state/`、`deploy/runner/data/`、
|
||||||
|
`deploy/runner/.env`;给 `auto-deploy.sh` 加可执行位(`git` 只记可执行位)。
|
||||||
|
|
||||||
|
**不做**的事及理由:
|
||||||
|
|
||||||
|
- 每次部署不做数据库备份:部署只改代码/配置,DB 不动;且 `deploy/backups/` 是 `root:root`,
|
||||||
|
CI 以 `ymy` 跑写不进去。版本升级仍走 README §7(带备份);
|
||||||
|
- 不自动重推 `issue-templates`:运营动作,不该跟代码推送耦合。
|
||||||
|
|
||||||
|
### 5.3 新增 `customization/check.sh <base-url>`
|
||||||
|
|
||||||
|
`preview.sh check` 里那一串"定制有没有生效"的断言(首页文案、页脚、meta、静态页、官网链接、
|
||||||
|
不出现「工单」、登录页两张卡、无通行密钥方框)正是部署后要守的东西。落地时把它抽出来共用:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
customization/check.sh http://127.0.0.1:2081 # 预览
|
||||||
|
customization/check.sh https://cpp.tongji.sh/QA # 生产(CI 里调)
|
||||||
|
```
|
||||||
|
|
||||||
|
生产侧再加两条(今天踩过的坑,必须自动化守住):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1) OIDC 认证源注册成功: 必须是 307 跳到统一身份认证; 404 = 认证源没注册上
|
||||||
|
curl -sS --noproxy '*' -o /dev/null -w '%{http_code} %{redirect_url}\n' \
|
||||||
|
"${BASE}/user/oauth2/%E9%AB%98%E7%A8%8B%E7%BB%9F%E4%B8%80%E8%BA%AB%E4%BB%BD%E8%AE%A4%E8%AF%81"
|
||||||
|
# 2) 登录页有「管理员登录」卡片且没有 passkey 空方框
|
||||||
|
curl -sS --noproxy '*' -H 'Accept-Language: zh-CN' "${BASE}/user/login" | grep -c '管理员登录'
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 6. 失败与回滚
|
||||||
|
|
||||||
|
| 失败点 | 行为 |
|
||||||
|
|---|---|
|
||||||
|
| `build.py` 报错(overrides 键不存在/占位符改坏/文件不可读) | 立即中止,**不碰容器**,Actions 标红 |
|
||||||
|
| `docker compose up -d` 失败(配置语法/镜像缺失) | 重试无意义 → 直接回滚 |
|
||||||
|
| 容器起不来(模板报错、权限 600 之类的 `[F]`) | `verify.sh` 等到 start_period 结束仍非 healthy → 回滚 |
|
||||||
|
| 验证断言失败(首页文案丢了、OIDC 404、出现「工单」) | 回滚 |
|
||||||
|
| 回滚也失败 | 脚本打印现场并 `exit 1`;线上仍是坏版本,需要人工介入(`docker compose logs`) |
|
||||||
|
| runner 掉线 | 推送后 Actions 显示"等待 runner",**不会**部署、也不影响线上;`docker compose up -d` 恢复 |
|
||||||
|
|
||||||
|
回滚 = `git checkout --detach <上一个成功 SHA>` + 重新 `up -d`,只动代码与挂载文件;
|
||||||
|
数据库、`/srv/gitea` 数据、`.env` 全程不参与,所以几十秒内完成。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 7. 安全
|
||||||
|
|
||||||
|
- job 容器里挂了 `docker.sock`,而 `docker` 组等价 root;host 模式(备选 B)更是直接以 `ymy` 在
|
||||||
|
宿主执行。所以:
|
||||||
|
|
||||||
|
1. runner 只注册成**仓库级**(`/repos/{owner}/{repo}/actions/runners/registration-token`),
|
||||||
|
不要注册成 instance/org 级——否则组织里任何仓库都能用这个 runner 拿到宿主 root;
|
||||||
|
2. `main` 必须开分支保护(PR + review)。贡献者是课程团队,属于可信范围,但
|
||||||
|
"谁有写权限 = 谁能 root 宿主"这条要写明白;
|
||||||
|
3. **落地前确认 fork PR 的工作流策略**(§9.1):若 fork PR 能不经批准直接跑 workflow,
|
||||||
|
等于把宿主 root 交给外部 PR;确认之前不要把仓库开放给不可信贡献者。若策略不可控,
|
||||||
|
退化为 §10 的 cron 轮询(只跑宿主上的固定脚本,不执行仓库里的代码);
|
||||||
|
4. `[skip deploy]`、`if:` 是防误操作,不是安全边界。
|
||||||
|
|
||||||
|
- 凭据最小化:部署流程**不需要任何 git token**(从本机裸仓库 fetch);注册令牌一次性用完即弃;
|
||||||
|
只有将来要回写状态/发 Issue 时才需要 Actions secrets(1.27 支持仓库级
|
||||||
|
`/repos/{owner}/{repo}/actions/secrets`)。
|
||||||
|
|
||||||
|
- `gitea/act_runner` 镜像来自 Docker Hub 的官方组织仓库(本机 daemon 经代理拉取);
|
||||||
|
落地时记录 tag/digest,升级方式与 Gitea 同(写进 README 升级章节)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 8. 日常操作
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 手动部署当前 main(不依赖 Actions/runner)
|
||||||
|
/home/ymy/deploy/tjhlp-gitea/deploy/scripts/auto-deploy.sh
|
||||||
|
|
||||||
|
# 回滚到指定提交
|
||||||
|
cd /home/ymy/deploy/tjhlp-gitea && git checkout --detach <sha> && ./deploy/scripts/auto-deploy.sh
|
||||||
|
|
||||||
|
# runner 启停 / 看日志
|
||||||
|
cd /home/ymy/deploy/tjhlp-gitea/deploy/runner && docker compose logs -f runner
|
||||||
|
docker compose stop runner && docker compose start runner
|
||||||
|
|
||||||
|
# 平台日志(部署后排查)
|
||||||
|
docker compose -f /home/ymy/deploy/tjhlp-gitea/deploy/compose.yaml logs -f gitea
|
||||||
|
# 每次运行的完整日志在 仓库 → Actions 里
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 9. 尚未验证的点(诚实清单)
|
||||||
|
|
||||||
|
已由本机预演确认、不再是待确认项的:job 镜像里有 `git 2.55`/`Python 3.10`/docker CLI ✓;
|
||||||
|
act_runner v0.6.1 支持 `:host` 标签与 `container.network: host` ✓;compose 插件在 job 容器里
|
||||||
|
可用 ✓;部署克隆、回环 `127.0.0.1:2080`、经 Apache 的 `10.80.42.185/QA` 在 job 容器内都通 ✓。
|
||||||
|
|
||||||
|
仍然未知:
|
||||||
|
|
||||||
|
1. **fork PR 的 workflow 审批行为**(安全前提):用一个测试 fork 发 PR 验证;在此之前按 §7.3 处理。
|
||||||
|
2. **workflow 语法支持面**:`concurrency`、`timeout-minutes`、`permissions`、job 级 `if` 里的
|
||||||
|
`contains(...)` 在 1.27 的实现里是否都生效 —— 第一次真实运行即知。
|
||||||
|
3. **Gitea 侧的调度与日志回传**:本机只预演了 job *执行*,没预演调度/日志上报。第一次真实
|
||||||
|
运行会验证。此外部署过程本身会重启 gitea 容器,job 与 Gitea 的连接可能短暂断开
|
||||||
|
(act_runner 会重试),表现为日志里若干 `failed to fetch task` / `unexpected EOF` —— 属正常现象。
|
||||||
|
4. **`github.sha` / `github.event.head_commit.message`** 的取值(试运行时 echo 一次确认)。
|
||||||
|
5. **Actions 日志保留与体积**:`[actions] LOG_RETENTION_DAYS`(默认 365)与存储位置。
|
||||||
|
6. **Gitea 是否支持"环境审批"**:若有 deployments/environments 的审批,可作为
|
||||||
|
"自动部署但上线要点一下"的中间档。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 10. 备选方案
|
||||||
|
|
||||||
|
| 方案 | 何时选 | 代价 |
|
||||||
|
|---|---|---|
|
||||||
|
| **B. 宿主二进制 + host 模式** | 不想给 job 容器挂 docker.sock / 不想维护 job 镜像 | 需要一次 sudo 装 systemd 单元;label 用 `self-hosted:host`(v0.6.1 配置里确认支持) |
|
||||||
|
| **cron 轮询 + `auto-deploy.sh`** | fork PR 策略不可控,或不想让仓库里的代码在宿主上执行 | 延迟 ≤60s;无 UI/日志,只有落盘日志 |
|
||||||
|
| **纯手工** | 推送频率低、每次都想人工确认 | 就是现在这样 |
|
||||||
|
|
||||||
|
cron 版的触发部分(其余复用 §5.2 的脚本):
|
||||||
|
|
||||||
|
```cron
|
||||||
|
# crontab -e (ymy)
|
||||||
|
* * * * * cd /home/ymy/deploy/tjhlp-gitea && git fetch -q origin main && \
|
||||||
|
[ "$(git rev-parse origin/main)" != "$(cat deploy/.state/last-deployed 2>/dev/null)" ] && \
|
||||||
|
./deploy/scripts/auto-deploy.sh "$(git rev-parse origin/main)" >> deploy/.state/cron.log 2>&1
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 11. 落地顺序(一句话版)
|
||||||
|
|
||||||
|
```text
|
||||||
|
4.1 部署克隆 → 4.2 拿仓库级令牌 + docker compose 起 runner → 4.3 只留 workflow_dispatch
|
||||||
|
手动跑通并演练一次回滚 → 4.4 打开 push 触发 + main 分支保护
|
||||||
|
```
|
||||||
+17
-9
@@ -161,19 +161,27 @@ services:
|
|||||||
# 这里显式声明, 避免上游改默认值时行为漂移
|
# 这里显式声明, 避免上游改默认值时行为漂移
|
||||||
GITEA__oauth2__ENABLED: "true"
|
GITEA__oauth2__ENABLED: "true"
|
||||||
|
|
||||||
# --- 出站代理: 必须显式给值, 不能让 compose 自动注入 -------------------
|
# --- 出站代理: 显式给值挡掉 compose 的自动注入, 默认【不用代理】 --------
|
||||||
# ★ docker compose 会把【运行 compose 的那个 shell 里】的 http_proxy/https_proxy
|
# ★ docker compose 会把【运行 compose 的那个 shell 里】的 http_proxy/https_proxy
|
||||||
# 自动注入容器, 而不同 shell 的值可能不同。若注入的是 127.0.0.1:7890,
|
# 自动注入容器。本机登录 shell 里是 127.0.0.1:7890, 而那个地址在容器里指向
|
||||||
# 那个地址在容器里指向容器自己的 loopback, 于是 Gitea 启动时 OIDC discovery 失败:
|
# 容器自己, 于是 Gitea 启动时 OIDC discovery 失败:
|
||||||
# initOAuth2Sources() [E] Unable to register source: 高程统一身份认证 due to
|
# initOAuth2Sources() [E] Unable to register source: 高程统一身份认证 due to
|
||||||
# proxyconnect tcp: dial tcp 127.0.0.1:7890: connect: connection refused
|
# proxyconnect tcp: dial tcp 127.0.0.1:7890: connect: connection refused
|
||||||
# 后果: /user/oauth2/<认证源> 返回 404, 统一身份认证登录不可用(2026-09-11 实际踩到)。
|
# 后果: /user/oauth2/<认证源> 返回 404, 统一身份认证登录不可用(2026-09-11 实际踩到)。
|
||||||
# 默认值 = 改造前宿主机 app.ini 所在环境的代理设置(容器可达的局域网代理),
|
# 显式赋值可以挡住注入 —— 哪怕给的是空值。
|
||||||
# 且 NO_PROXY 覆盖 10.80.42.185, 让 OIDC discovery 直连。改/清空见 deploy/.env。
|
#
|
||||||
HTTP_PROXY: ${GITEA_HTTP_PROXY:-https://cpp.tongji.sh:7890}
|
# 不用代理的理由(2026-09-13 实测):
|
||||||
HTTPS_PROXY: ${GITEA_HTTPS_PROXY:-https://cpp.tongji.sh:7890}
|
# * 容器直连外网是通的 —— dl.gitea.com / api.github.com / codeload.github.com
|
||||||
http_proxy: ${GITEA_HTTP_PROXY:-https://cpp.tongji.sh:7890}
|
# 在容器里直接 curl 都是 200/301(github.com 主站直连会超时, 但平台不依赖它);
|
||||||
https_proxy: ${GITEA_HTTPS_PROXY:-https://cpp.tongji.sh:7890}
|
# * 功能相关的出站只有 OIDC, 目标是 10.80.42.185, 容器内直连就是 200;
|
||||||
|
# * 宿主 7890 那个代理是 ssh 转发的开发用代理, 只监听宿主 127.0.0.1,
|
||||||
|
# 容器里连不上(127.0.0.1:7890 是容器自己; 10.80.42.185:7890 实测 connect refused)。
|
||||||
|
# 将来真要给容器配代理, 必须是【容器可达】的地址(隧道绑 LAN 口, 或用 host 网络兜底),
|
||||||
|
# 再在 deploy/.env 里给 GITEA_HTTP_PROXY。
|
||||||
|
HTTP_PROXY: ${GITEA_HTTP_PROXY:-}
|
||||||
|
HTTPS_PROXY: ${GITEA_HTTPS_PROXY:-}
|
||||||
|
http_proxy: ${GITEA_HTTP_PROXY:-}
|
||||||
|
https_proxy: ${GITEA_HTTPS_PROXY:-}
|
||||||
NO_PROXY: ${GITEA_NO_PROXY:-localhost,127.0.0.1,::1,10.80.42.185,.local,.internal}
|
NO_PROXY: ${GITEA_NO_PROXY:-localhost,127.0.0.1,::1,10.80.42.185,.local,.internal}
|
||||||
no_proxy: ${GITEA_NO_PROXY:-localhost,127.0.0.1,::1,10.80.42.185,.local,.internal}
|
no_proxy: ${GITEA_NO_PROXY:-localhost,127.0.0.1,::1,10.80.42.185,.local,.internal}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# 复制成 .env 后填写(deploy/runner/.env 已 gitignore)
|
||||||
|
#
|
||||||
|
# RUNNER_REGISTRATION_TOKEN: 仓库 → Settings → Actions → Runners → 创建 Runner 时给的令牌。
|
||||||
|
# 一次性, 用完即弃; 注册成功后身份存在 ./data/.runner, 重启不会再注册。
|
||||||
|
RUNNER_REGISTRATION_TOKEN=
|
||||||
|
|
||||||
|
# 默认值在 compose.yaml 里, 需要时再覆盖
|
||||||
|
#GITEA_INSTANCE_URL=https://cpp.tongji.sh/QA
|
||||||
|
#RUNNER_NAME=tjhlp-gitea-1
|
||||||
|
# runner 的 label 不在这里配: 以 config.yaml 的 runner.labels 为准(实测 env 会被忽略)
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
# Gitea Actions runner —— 跑在容器里, 由 docker 自己拉起(不需要 root, ymy 在 docker 组即可)。
|
||||||
|
#
|
||||||
|
# cd deploy/runner
|
||||||
|
# cp .env.example .env # 填 RUNNER_REGISTRATION_TOKEN(仓库 → Settings → Actions → Runners)
|
||||||
|
# docker compose up -d
|
||||||
|
# docker compose logs -f runner
|
||||||
|
#
|
||||||
|
# 详见 ../ci-cd.md §4.2。注册结果存在 ./data/.runner, 重启不会重复注册。
|
||||||
|
name: gitea-runner
|
||||||
|
|
||||||
|
services:
|
||||||
|
runner:
|
||||||
|
image: gitea/act_runner:latest # 实测 arm64 / v0.6.1
|
||||||
|
container_name: gitea-runner
|
||||||
|
restart: unless-stopped
|
||||||
|
environment:
|
||||||
|
# 变量名与镜像里 /usr/local/bin/run.sh 一致
|
||||||
|
GITEA_INSTANCE_URL: ${GITEA_INSTANCE_URL:-https://cpp.tongji.sh/QA}
|
||||||
|
GITEA_RUNNER_REGISTRATION_TOKEN: ${RUNNER_REGISTRATION_TOKEN:?deploy/runner/.env 里给 RUNNER_REGISTRATION_TOKEN}
|
||||||
|
GITEA_RUNNER_NAME: ${RUNNER_NAME:-tjhlp-gitea-1}
|
||||||
|
# 注意: 不要在这里设 GITEA_RUNNER_LABELS —— act_runner 会警告
|
||||||
|
# "Labels from command will be ignored, use labels defined in config file.",
|
||||||
|
# label 以 config.yaml 的 runner.labels 为准(实测)。
|
||||||
|
CONFIG_FILE: /config/config.yaml
|
||||||
|
volumes:
|
||||||
|
- /var/run/docker.sock:/var/run/docker.sock # runner 用它拉起 job 容器
|
||||||
|
- ./data:/data # 注册凭据 / 缓存(gitignore)
|
||||||
|
- ./config.yaml:/config/config.yaml:ro
|
||||||
|
logging:
|
||||||
|
driver: json-file
|
||||||
|
options:
|
||||||
|
max-size: "10m"
|
||||||
|
max-file: "3"
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
# act_runner 配置 —— 关键项都有注释, 依据是 act_runner v0.6.1 自带的 generate-config 输出。
|
||||||
|
log:
|
||||||
|
level: info
|
||||||
|
|
||||||
|
runner:
|
||||||
|
file: /data/.runner # 与 compose.yaml 的 ./data 挂载对应; 注册后保存在这里
|
||||||
|
capacity: 1 # 部署必须串行: 一次只跑一个 job
|
||||||
|
timeout: 30m
|
||||||
|
labels:
|
||||||
|
# job 跑在容器里(network: host), 镜像用 Gitea 官方 runner 镜像(实测 arm64 可用)。
|
||||||
|
# 换成 catthehacker/ubuntu:act-22.04 也可以; 记得同步 compose.yaml 的 GITEA_RUNNER_LABELS。
|
||||||
|
- "self-hosted:docker://docker.gitea.com/runner-images:ubuntu-22.04"
|
||||||
|
|
||||||
|
container:
|
||||||
|
# host: job 容器与宿主共用网络 —— verify.sh 里对 127.0.0.1:2080 的检查才有效,
|
||||||
|
# 10.80.42.185 也不需要额外放行。
|
||||||
|
network: host
|
||||||
|
# ★ 不要在这里挂 /var/run/docker.sock: act_runner 会自动把 docker daemon socket
|
||||||
|
# 挂进 job 容器(container.docker_host 的默认行为), 再挂一次会直接失败:
|
||||||
|
# failed to create container: 'Duplicate mount point: /var/run/docker.sock'
|
||||||
|
# (2026-09-13 用 `act_runner exec` 预演 job 时实测踩到 —— 若没预演, 第一次真实
|
||||||
|
# 部署就会以这个错误告终。)
|
||||||
|
#
|
||||||
|
# 下面这些挂载是 act_runner 不管的:
|
||||||
|
# * 部署克隆同路径挂载: job 容器里 `docker compose` 会把相对挂载解析成绝对路径后
|
||||||
|
# 交给宿主 daemon, 两边路径必须一致, 否则会挂到空目录;
|
||||||
|
# * 宿主 docker CLI + compose 插件: 不依赖 job 镜像里带没带(宿主是 glibc, Ubuntu 镜像能用)。
|
||||||
|
options: >-
|
||||||
|
--volume /home/ymy/deploy:/home/ymy/deploy
|
||||||
|
--volume /usr/bin/docker:/usr/bin/docker:ro
|
||||||
|
--volume /usr/libexec/docker/cli-plugins:/usr/libexec/docker/cli-plugins:ro
|
||||||
|
force_pull: false # 镜像本地已有就不再拉
|
||||||
|
|
||||||
|
cache:
|
||||||
|
enabled: true
|
||||||
|
dir: /data/cache
|
||||||
Executable
+141
@@ -0,0 +1,141 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# main 自动部署 —— 由 .gitea/workflows/deploy.yml 调用, 也可以手工执行。
|
||||||
|
#
|
||||||
|
# ./auto-deploy.sh # 部署当前 checkout
|
||||||
|
# ./auto-deploy.sh <sha> # 部署指定提交
|
||||||
|
#
|
||||||
|
# 流程: build.py(生成+校验) → docker compose up -d → 验证(verify.sh + check.sh)
|
||||||
|
# 任一步失败 → 回滚到 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"
|
||||||
|
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。
|
||||||
|
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 before after
|
||||||
|
prepare_custom_dirs || return 1
|
||||||
|
before="$(custom_hash)"
|
||||||
|
"${PY}" customization/build.py || return 1 # 生成语言文件 + 规范 custom/ 权限
|
||||||
|
"${PY}" customization/build.py --check || return 1 # 生成物/权限校验, 不过就中止, 不碰容器
|
||||||
|
after="$(custom_hash)"
|
||||||
|
(cd deploy && docker compose up -d) || return 1 # 幂等: 只有配置/挂载/镜像变化时才重建
|
||||||
|
if [[ ${before} != "${after}" ]]; then
|
||||||
|
echo "[auto-deploy] custom/ 有变化(模板/静态页/语言文件), 重启 gitea 使其生效"
|
||||||
|
(cd deploy && docker compose restart gitea) || return 1
|
||||||
|
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 || true
|
||||||
|
verify || true
|
||||||
|
}
|
||||||
|
|
||||||
|
# 包成一个函数再放进 if: 避免依赖 "&& 列表最后一个命令在 if 条件里是否触发 errexit" 这类细节
|
||||||
|
pipeline() { deploy && verify; }
|
||||||
|
|
||||||
|
if pipeline; then
|
||||||
|
echo "${TARGET}" >"${STATE_FILE}"
|
||||||
|
echo "[auto-deploy] ✅ 部署成功 ${TARGET}"
|
||||||
|
else
|
||||||
|
echo "[auto-deploy] ❌ 部署或验证失败, 开始回滚"
|
||||||
|
rollback
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
Reference in New Issue
Block a user