Files
eng-standards-main/scripts/new-project.sh
T
姚章浩 7f8698c16a fix(gen): 生成器修掉 gofmt 假绿、门禁统一叫 verify、缺锁即失败
生成器产出的 scripts/verify.sh 里写着 `step gofmt -l . || fail=1` ——
gofmt -l 列出不合规文件时**退出码仍是 0**,所以这一步永远是绿的。
这条假绿会跟着每个新工程走,是新仓最容易继承的一条。

改法:加 check_gofmt(),判**输出**是否为空;输出非空就列出文件并非零退出。
在生成物里实测过:故意写一个没格式化的 main.go ⇒ verify 退出码 1 且列出该文件;
gofmt -w 之后 ⇒ 退出码 0。

同时:
- Makefile 的门禁目标统一成 verify(check 保留为别名,不起第二套逻辑),
  与正本 §3.1 的"唯一入口"、以及 CI 里跑的那条命令同名。
- package.json 存在时:有锁必须 npm ci,没锁直接失败(不回落 npm install);
  没声明 format:check 也判红(前端格式必须有门禁),并提示怎么补。
- 收尾提示去掉"填 build.yml 里 deploy:test 的 TODO"—— 模板里已经没有 deploy 作业了。

顺带修一个自己踩的坑:收尾那段 heredoc 没加引号,新写的说明里带了反引号,
被 shell 先执行、整段字直接消失而退出码仍是 0。改成不用反引号,并把原因写在注释里。

验证:生成器在空目录跑通(exit 0),生成物 10 个文件齐全;
生成的门禁在空仓上退出码 1("入口待补,不算全绿"),不是静默通过。
2026-10-12 00:11:41 +08:00

203 lines
8.6 KiB
Bash
Executable File
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
#!/usr/bin/env bash
# 起一个「默认就合规」的新工程(正本 §8 的自动化部分)。
#
# 用法: new-project.sh <目标目录> <owner/repo> [runner-name]
# 例: new-project.sh ~/proj/my-svc Weknora/my-svc runner-weknora-my-01
#
# 刻意**不覆盖**任何已有文件:目标目录非空就直接拒绝(半途改主意不会留下半成品)。
# 依赖:正本仓本身(templates/ 与已验证的闸门脚本都在里面)—— 不在正本仓里跑会拒。
set -euo pipefail
STANDARDS_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
TPL="$STANDARDS_DIR/templates"
TARGET="${1:?用法: new-project.sh <目标目录> <owner/repo> [runner-name]}"
REPO="${2:?缺少 owner/repo,例: Weknora/my-svc}"
RUNNER="${3:-${REPO##*/}-runner-01}"
[ -d "$TPL" ] || { echo "❌ 找不到 templates/($TPL)—— 本脚本必须在正本仓里运行" >&2; exit 1; }
case "$REPO" in */*) ;; *) echo "❌ owner/repo 格式不对: $REPO" >&2; exit 1 ;; esac
NAME="${REPO##*/}"
DIR="$(cd "$(dirname "$TARGET")" 2>/dev/null && pwd)/$(basename "$TARGET")"
if [ -e "$DIR" ] && [ -n "$(ls -A "$DIR" 2>/dev/null)" ]; then
echo "❌ 目标目录非空:$DIR(不覆盖任何东西)" >&2; exit 1
fi
say() { printf '\n== %s ==\n' "$*"; }
say "1/7 目录"
mkdir -p "$DIR"
cd "$DIR"
echo " $DIR"
say "2/7 .gitignore / 门禁入口"
cp "$TPL/gitignore" .gitignore
# verify.sh:本地门禁 —— 必须与 CI 的 build 作业同一条命令、串行、失败即停(正本 §3.1)
cat > scripts_verify.tmp <<'SH'
#!/usr/bin/env bash
# 本地门禁:一条命令跑完、串行、失败即停、末尾汇总(正本 §3.1)。
# 与 CI 的 build 作业**同一套步骤**,只允许两处刻意差异(正本 §3.1):外部环境对拍在 CI 跳过、对拍单独一步。
set -uo pipefail
LOG="$(mktemp)"; fail=0; n=0; ran=""
step() { n=$((n+1)); echo ""; echo "── [$n] $* ──"; "$@" 2>&1 | tee -a "$LOG"; return "${PIPESTATUS[0]}"; }
export PATH="/opt/citools/go/bin:/opt/citools/bin:$PATH"
if [ -f go.mod ]; then
ran="go"
check_gofmt() { # ⚠️ gofmt -l 列出文件时**退出码仍是 0**:判输出,不判退出码
U="$(gofmt -l $(git ls-files '*.go' 2>/dev/null) 2>/dev/null)"
[ -z "$U" ] || { echo "未格式化的文件:"; printf '%s\n' "$U"; return 1; }
}
step check_gofmt || fail=1 # 格式:CI 会因为这一条红
step go vet ./... || fail=1 # 静态检查:类型错了后面全是噪声
step go build ./... || fail=1 # 构建
step go test ./... || fail=1 # 单测(Go 会自己编译测试程序;不是"测构建产物")
fi
if [ -f pyproject.toml ] || [ -f requirements.txt ] || [ -f setup.py ]; then
ran="$ran python"
step ruff format --check . || fail=1
step ruff check . || fail=1
step uv run pytest -q || fail=1
fi
if [ -f package.json ]; then
ran="$ran node"
if [ -f package-lock.json ]; then
step npm ci || fail=1 # 按锁装;缺锁**不**退化成 npm install(那会重写锁文件)
else
echo "❌ 没有 package-lock.json:不接受无约束安装(先提交锁文件)"; fail=1
fi
if grep -q '"format:check"[[:space:]]*:' package.json 2>/dev/null; then
step npm run format:check || fail=1
else
echo "❌ package.json 未声明 format:check —— 前端格式没有门禁(加 prettier --check)"; fail=1
fi
step npm run build || fail=1
step npm test || fail=1
fi
if [ -z "$ran" ]; then echo ""; echo "⚠️ 未识别到构建入口(go.mod / pyproject.toml / package.json 都没有)—— 入口待补,不算全绿"; fail=1; fi
echo ""; echo "════════════════════════════════════════"
if [ "$fail" -eq 0 ]; then
echo "✅ 本地门禁全过"
rm -f "$LOG" # 夹具要打扫(正本 §3.2-5):成功时不留日志,否则 $TMPDIR 会攒到几万条
else
echo "❌ 门禁未通过 —— 先修它,再提交"
echo "(完整日志留在:$LOG)"
fi
exit "$fail"
SH
mkdir -p scripts && mv scripts_verify.tmp scripts/verify.sh && chmod +x scripts/verify.sh
cat > Makefile <<'MK'
# 本地门禁入口:一条命令跑完(正本 §3.1)。CI 的 build 作业跑同一套步骤。
# 名字统一用 `verify`(如本环境另有一套叫 `check` 的历史习惯,让它成为别名,别起第二套逻辑)。
.PHONY: verify check
verify:
bash scripts/verify.sh
check: verify
MK
say "3/7 CI 工作流"
mkdir -p .gitea/workflows .gitea/scripts docs
sed "s|<PROJECT>|$NAME|g" "$TPL/gitea-build.yml" > .gitea/workflows/build.yml
sed "s|<PROJECT>|$NAME|g" "$TPL/gitea-prod-deploy.yml" > .gitea/workflows/deploy-production.yml
say "4/7 闸门与上报脚本(从正本仓逐字节复制)"
cp "$TPL/ci_gate.py" .gitea/scripts/ci_gate.py
cp "$TPL/ci_report.py" .gitea/scripts/ci_report.py
chmod +x .gitea/scripts/*.py
say "5/7 AGENTS.md(从 templates/README.md 的骨架抽取并替换)"
python3 - "$TPL/README.md" "$NAME" "$REPO" > AGENTS.md <<'PY'
import re, sys
src, name, repo = sys.argv[1:4]
t = open(src, encoding="utf-8").read()
m = re.search(r"^````markdown\n(.*?)^````", t, re.S | re.M)
if not m:
sys.exit("❌ templates/README.md 里找不到 ```markdown 骨架块")
body = m.group(1)
body = body.replace("<PROJECT>", name).replace("<ns>/<repo>", repo)
sys.stdout.write(body)
PY
echo " AGENTS.md($(wc -c < AGENTS.md) 字节)"
say "6/7 docs/提交规范.md"
cat > docs/提交规范.md <<MD
# 提交规范
正本:Git / 提交 / CI-CD 规范(Gitea 版)—— 仓库 \`zheromiku/eng-standards-main\`,本机工作副本 \`~/eng-standards/\`。
## 格式
\`\`\`
<type>(<scope>): 一句话说清"改了什么"
正文:为什么这么改 / 现象 / 根因 / 怎么验的。
\`\`\`
- \`type\`:feat fix docs style refactor perf test build ci chore revert
- \`scope\`:本仓库的真实模块名,可选,小写
- 冒号后一个空格;描述 ≥3 字符;标题 **≤72 字符、结尾不加句号**
- 放行自动生成的提交:\`Merge \` / \`Revert "\` / \`fixup! \` / \`squash! \` / \`amend! \`
- **一件事一个提交**,且每个提交都要能各自编译/构建通过
## 正文写"为什么",不写"是什么"
diff 已经写了"是什么"。正文回答:当时为什么这么改、试过什么、怎么确认它对了。
四种要素:**现象** / **根因**(具体到文件·行·机制)/ **取舍**(为什么不用那个更自然的写法)/ **证据**(跑了什么、量到了什么)。
## 两条闸门
1. 本机 hook \`~/.githooks/commit-msg\`(\`core.hooksPath\` 全局生效)—— 快速反馈
2. CI \`.gitea/scripts/ci_gate.py\` —— 权威闸门,在**编译之前**执行
⚠️ \`--no-verify\` 只骗得过第一条。
## 写法禁忌
不要在提交信息里用反引号与 \`\$()\`:shell 会先做命令替换,轻则信息被改写,重则**执行**了里面的东西,
而退出码仍是 0、没有任何报错。一律用带引号的 heredoc:
\`\`\`bash
git commit -F - <<'EOF'
fix(parser): 修复表格解析越界导致的 500
根因:……
EOF
\`\`\`
MD
say "7/7 git 仓库"
git init -q -b main
echo " 已初始化(默认分支 main),未提交"
cat <<EOF
== 下一步 ==
1) cd "$DIR" && git add -A
git commit -F - <<'MSG'
chore(init): 初始化工程骨架(CI + 门禁 + 提交规范)
由 ~/eng-standards/scripts/new-project.sh 生成:提交信息闸门、编译自检、
静态产物预览与微信上报(ci-bridge)。正本见 zheromiku/eng-standards-main。
MSG
2) 建远端并在网页建仓:$REPO(**不要**勾"初始化仓库")
git remote add origin https://gitea.zheromiku.top/$REPO.git && git push -u origin main
3) 挂仓库级 Runner + bridge 变量(幂等):
bash /srv/aiball/runner/attach_repo.sh $REPO $RUNNER
4) (可选)需要"谁都不能直推"时才开分支保护;**默认不开**(正本 §1.3)
5) **反向自检**(正本 §3.2-3):推一个故意违规的提交,确认 gate 红、且 build 没跑
6) 部署(CD)**不在这里**:本骨架只做 CI。要部署时**另写一个**独立 workflow
(只由 workflow_dispatch 触发,且 cancel-in-progress 必须为 false),
别把 deploy 作业塞回 build.yml ——占位作业会打印 TODO 然后返回成功,那是假报成功(正本 §8)。
⚠️ 这段说明写在这里、不写进那个 heredoc 里的原因:外层 heredoc 没加引号,
反引号会被 shell 先执行 —— 上面这行原先带反引号,输出里那段字直接消失了(退出码仍是 0)。
EOF