CI/CD / 系统课时
规划示例项目结构
规划示例项目结构
本课将搭建一个适合 CI/CD 演示的最小项目骨架。完成后,应用代码、自动化测试、构建脚本、容器配置和部署清单各有固定位置,后续编写流水线时可以直接引用,不必临时寻找文件。
学习目标
- 设计职责清晰的 CI/CD 示例项目目录
- 生成可供后续流水线使用的最小文件骨架
- 理解哪些文件属于应用、构建与部署边界
先确定最小需求
一个可用于 CI/CD 实战的项目,至少需要五类内容:应用源码、自动化测试、依赖或构建描述、容器镜像定义,以及部署环境使用的清单。
本课采用通用目录,不绑定具体云平台。流水线配置单独放在仓库根目录或平台约定位置,部署清单集中放入 deploy,避免与应用源码混在一起。
推荐目录结构
ci-cd-demo/
├── src/
│ └── app.py
├── tests/
│ └── test_app.py
├── scripts/
│ └── verify.sh
├── deploy/
│ ├── base/
│ │ └── deployment.yaml
│ └── environments/
│ ├── test/
│ └── prod/
├── Dockerfile
├── requirements.txt
├── .gitignore
└── README.mdsrc 只保存应用代码,tests 保存自动化测试,scripts 保存可被开发者和 CI 重复调用的脚本。deploy/base 保存通用部署定义,deploy/environments 保存各环境差异,避免复制多份完整清单。
用命令生成项目骨架
下面的命令可以在当前目录创建完整骨架。已有同名目录时应先确认内容,避免覆盖原项目。
#!/usr/bin/env bash
set -euo pipefail
project_dir="ci-cd-demo"
# 先创建职责分离的目录,再创建流水线需要引用的入口文件。
mkdir -p "$project_dir/src" "$project_dir/tests" "$project_dir/scripts"
mkdir -p "$project_dir/deploy/base"
mkdir -p "$project_dir/deploy/environments/test"
mkdir -p "$project_dir/deploy/environments/prod"
touch "$project_dir/src/app.py" "$project_dir/tests/test_app.py"
touch "$project_dir/scripts/verify.sh"
touch "$project_dir/deploy/base/deployment.yaml"
touch "$project_dir/Dockerfile" "$project_dir/requirements.txt"
touch "$project_dir/.gitignore" "$project_dir/README.md"
# 排序输出便于人工或流水线稳定核对文件集合。
find "$project_dir" -type f | sort预期输出:
ci-cd-demo/.gitignore
ci-cd-demo/Dockerfile
ci-cd-demo/README.md
ci-cd-demo/deploy/base/deployment.yaml
ci-cd-demo/requirements.txt
ci-cd-demo/scripts/verify.sh
ci-cd-demo/src/app.py
ci-cd-demo/tests/test_app.py不同系统的排序结果可能略有差异,但文件集合应一致。
明确各目录的责任
应用目录负责“程序如何运行”,测试目录负责“程序是否正确”,构建文件负责“如何生成可交付制品”,部署目录负责“制品如何进入目标环境”。这四个边界清晰后,流水线阶段就能自然映射为测试、构建、发布和部署。
scripts/verify.sh 应封装本地与 CI 都会执行的检查命令。这样开发者可以在提交前复现流水线行为,避免把关键逻辑全部写进某个平台专用的 YAML 文件。
环境目录只保存差异项,例如副本数、域名、资源限制和镜像标签。密码、令牌和私钥不应直接提交到仓库,应交给 CI 密钥库或部署平台的 Secret 机制管理。
验收项目骨架
检查根目录是否同时存在源码、测试、构建和部署入口;确认脚本命名能表达用途;确认测试与生产环境目录已经分开;最后执行 find 或编辑器目录树核对文件。
此时文件内容可以为空,因为本课只完成结构规划。后续课时再逐步补充可运行应用、测试代码、Dockerfile 和部署清单。
本课总结
- 示例项目应把源码、测试、脚本、容器配置和部署清单分开管理
- 通用部署定义与环境差异应分层保存,避免复制多份完整配置
- 可复用检查逻辑应放入脚本,让本地执行与 CI 执行保持一致
下一课预告
下一课将为这个项目补充可运行的应用与自动化测试,并验证本地构建入口是否适合接入 CI 流水线。