chore: move Jenkins pipeline config out of repo

This commit is contained in:
湛兮
2026-06-05 15:08:11 +08:00
parent 1dbeaa7209
commit c0b561b6cb
5 changed files with 6 additions and 418 deletions
+6 -17
View File
@@ -44,14 +44,11 @@
├── AGENTS.md # Codex/Agent 入口指令,当前指向 RTK.md
├── RTK.md # 项目协作规则和开发约定
├── docs/
── API.md # 前端对接接口文档
│ └── ENVIRONMENT_DEPLOYMENT.md # 测试/生产环境拆分与 Jenkins 规则
── API.md # 前端对接接口文档
├── deploy/
│ ├── env/
│ │ ├── test.env.example # 测试环境变量示例,不包含真实密码
│ │ └── production.env.example # 生产环境变量示例,不包含真实密码
│ ├── jenkins/
│ │ └── deploy-backend.sh # Jenkins 后端部署脚本
│ └── server/
│ ├── create-env.sh # 在服务器生成测试/生产真实环境变量
│ ├── docker-compose.mysql.test.yml # 测试 MySQL Compose 模板
@@ -85,7 +82,6 @@
│ │ └── tasks/ # 任务后台管理和员工端任务模块
│ └── shared/ # 通用响应结构和业务错误
├── docker-compose.yml # 本地 MySQL
├── Jenkinsfile # Jenkins 测试自动部署、生产手动 Tag 部署规则
├── package.json
├── pnpm-lock.yaml
├── README.md
@@ -103,9 +99,7 @@
| `AGENTS.md` | Agent 工具读取的入口文件,当前通过 `@RTK.md` 引入项目规则。 |
| `RTK.md` | 本项目的协作规则,例如使用中文说明、保持分层、改目录时同步 README。 |
| `docs/API.md` | 面向前端对接的完整接口文档,包含认证、权限、字段约束、示例请求响应和错误码。 |
| `docs/ENVIRONMENT_DEPLOYMENT.md` | 测试/生产环境拆分、Jenkins 参数、Tag 发布和服务器路径约定。 |
| `deploy/env/` | 测试/生产环境变量示例,只给字段结构,不提交真实密码。 |
| `deploy/jenkins/` | Jenkins 部署脚本。当前 `deploy-backend.sh` 会按环境发布到独立目录。 |
| `deploy/server/` | 服务器部署辅助文件。`create-env.sh` 在服务器本地生成测试/生产真实环境变量,Compose 模板分别启动测试和生产 MySQL。 |
| `migrations/` | 数据库迁移目录。所有建表、改表、初始化基础数据的 SQL 都放在这里。 |
| `src/app.ts` | 创建 Fastify 应用,注册路由,处理健康检查和全局错误。 |
@@ -124,7 +118,6 @@
| `src/modules/tasks/` | 任务模块,负责后台任务管理、员工端任务处理和任务事件日志。 |
| `src/shared/` | 跨模块复用的响应结构和业务错误类型。 |
| `docker-compose.yml` | 本地开发用 MySQL 容器配置。 |
| `Jenkinsfile` | 流水线入口。`develop` 合并自动部署测试环境;生产环境只能手动选择 Tag 部署。 |
| `package.json` | 项目信息、依赖和常用脚本;脚本会读取现有 `.env.development`。 |
| `pnpm-lock.yaml` | pnpm 锁文件,保证依赖版本一致。 |
| `tsconfig.json` | TypeScript 编译配置。 |
@@ -314,7 +307,7 @@ curl http://127.0.0.1:3500/health # 生产
只有返回里出现 `database: "up"`,才代表后端服务和 MySQL 都连通。
如果手动压缩部署,至少需要包含 `dist/``migrations/``deploy/``package.json``pnpm-lock.yaml`。不要把本机 `.env.*``node_modules/``src/``tsconfig.json``.git/` 打进部署包。
如果手动压缩部署,至少需要包含 `dist/``migrations/``package.json``pnpm-lock.yaml`。不要把本机 `.env.*``node_modules/``src/``tsconfig.json``.git/` 打进部署包。
可以在本机执行:
@@ -324,13 +317,9 @@ pnpm build:dev
命令执行完成后会得到最新的 `dist/`。如果需要压缩上传,由部署者手动选择要打包的文件;测试构建可执行 `pnpm build:test`,正式生产构建时执行 `pnpm build:pro`
## Jenkins 环境规则
## 环境构建约定
流水线规则见 [docs/ENVIRONMENT_DEPLOYMENT.md](./docs/ENVIRONMENT_DEPLOYMENT.md)
- 测试环境:`develop` 合并后自动触发,部署到 `/srv/www/test/access-manage/current`
- 生产环境:禁止代码合并自动触发,只能在 Jenkins 手动选择 `DEPLOY_ENV=production` 并填写 Gitea 项目 Tag。
- 生产部署会先 checkout 到 `RELEASE_TAG` 对应的提交,再构建和部署。
仓库只维护项目自身的构建脚本和环境变量示例,不维护流水线文件。测试、生产的触发规则和部署路径由外部 CI/CD 平台配置
## package.json 脚本说明
@@ -341,8 +330,8 @@ pnpm build:dev
| `pnpm dev` | 使用现有 `.env.development` 启动开发服务,并通过 `tsx watch` 监听代码变化。 | 日常开发接口时使用。 |
| `pnpm build` | 使用 `tsc` 编译 TypeScript,输出到 `dist/`。 | 准备运行编译产物或发布前验证时使用。 |
| `pnpm build:dev` | 清空旧 `dist/`,再执行 `pnpm build` 生成新的 `dist/`。 | 准备开发/测试服务器部署产物时使用。 |
| `pnpm build:test` | 清空旧 `dist/`,再执行 `pnpm build` 生成新的 `dist/`。 | Jenkins 测试环境构建时使用。 |
| `pnpm build:pro` | 清空旧 `dist/`,再执行 `pnpm build` 生成新的 `dist/`。 | 准备正式生产部署产物时使用。 |
| `pnpm build:test` | 清空旧 `dist/`,再执行 `pnpm build` 生成新的 `dist/`。 | 准备测试环境部署产物时使用。 |
| `pnpm build:pro` | 清空旧 `dist/`,再执行 `pnpm build` 生成新的 `dist/`。 | 准备生产环境部署产物时使用。 |
| `pnpm start` | 使用现有 `.env.development` 运行 `dist/server.js`。 | 已经执行过 `pnpm build` 后,用编译产物启动服务。 |
| `pnpm start:test` | 使用 `.env.test` 运行 `dist/server.js`。 | 服务器测试环境启动编译产物时使用。 |
| `pnpm start:prod` | 使用 `.env.production` 运行 `dist/server.js`。 | 服务器生产环境启动编译产物时使用。 |