test-github-cicd
C++ CI/CD 示例项目 🚀
这是一个简单的C++项目，用于演示GitHub CI/CD工作流程。
📚 文档导航
| 文档 | 说明 |
|---|---|
| README.md | 📖 本文件 - 项目概览和快速开始 |
| CICD_GUIDE.md | 🔄 CI/CD详细教程 - 深入理解持续集成原理 |
| RELEASE_GUIDE.md | 🚀 Release发布指南 - 自动发布机制说明 |
| WORKFLOWS_GUIDE.md | ⚙️ 工作流配置说明 - 所有工作流文件详解 |
�📥 快速下载
从 Releases 页面下载适合你操作系统的预编译版本：
- 🐧 Linux (Ubuntu)
- 🍎 macOS
- 🪟 Windows
项目结构
.
├── src/ # 源代码目录
│ ├── main.cpp # 主程序
│ ├── calculator.h # 计算器头文件
│ └── calculator.cpp # 计算器实现
├── tests/ # 测试代码目录
│ └── test_calculator.cpp # 单元测试
├── docs/ # 📚 项目文档目录
│ ├── CICD_GUIDE.md # CI/CD详细教程
│ ├── RELEASE_GUIDE.md # Release发布指南
│ └── WORKFLOWS_GUIDE.md # 工作流配置说明
├── .github/ # GitHub配置
│ └── workflows/ # 工作流文件
│ ├── ci.yml # CI/CD主工作流
│ └── publish-report.yml # 测试报告发布
├── CMakeLists.txt # CMake构建配置
├── LICENSE # MIT许可证
└── README.md # 本文件 - 项目概览
构建项目
mkdir build
cd build
cmake ..
cmake --build .
运行程序
./build/calculator_app
运行测试
./build/calculator_tests
CI/CD 工作流说明
本项目使用GitHub Actions实现完整的CI/CD流程，配置文件在 .github/workflows/ci.yml。
工作流触发条件
- 推送到
main或master分支时 - 创建Pull Request到
main或master分支时 - 手动触发（workflow_dispatch）
- 推送版本tag时（如
v1.0.0）
CI/CD 流程步骤
- 代码检出: 从仓库拉取最新代码
- 环境设置: 安装必要的编译工具和依赖
- 构建: 使用CMake在多个平台上编译项目
- 测试: 运行单元测试确保代码质量
- 质量检查: 代码格式和静态分析
- 打包: 将编译产物打包成分发格式
- 发布: 自动创建GitHub Release并上传文件
多平台支持
CI配置支持在以下平台上构建和测试：
- 🐧 Ubuntu (Linux) - gcc编译器
- 🍎 macOS - clang编译器
- 🪟 Windows - MSVC编译器
每次运行都会在这3个平台上并行执行，确保跨平台兼容性。
学习要点
通过这个项目，你可以学习到：
- 自动化构建: 每次代码提交都会自动触发构建
- 自动化测试: 确保代码质量，防止引入bug
- 多平台测试: 确保代码在不同操作系统上都能正常工作
- 持续集成: 频繁地将代码集成到主分支
- 工作流配置: 如何编写GitHub Actions的YAML配置文件
- 自动发布: 如何自动创建Release并分发二进制文件
- 徽章使用: 在README中展示项目状态
🎓 学习资源
- CI/CD概念: 阅读 docs/CICD_GUIDE.md 了解持续集成和持续部署的原理
- Release流程: 阅读 docs/RELEASE_GUIDE.md 了解自动发布机制
- GitHub Actions: 官方文档
- CMake教程: CMake官方文档
📥 下载和使用
下载预编译版本
从 Releases页面 下载适合你系统的版本：
Linux/macOS:
# 解压
tar -xzf calculator-*-x64.tar.gz
# 运行程序
./calculator_app
# 运行测试
./calculator_tests
Windows:
- 下载
calculator-windows-x64.zip - 解压文件
- 双击
calculator_app.exe运行
从源码编译
# 克隆仓库
git clone https://github.com/tyk-lab/test-github-cicd.git
cd test-github-cicd
# 创建构建目录
mkdir build && cd build
# 配置和编译
cmake ..
cmake --build .
# 运行
./calculator_app
🔄 CI/CD工作流
自动化流程
每次推送代码到 main 分支时：
- ✅ 自动在3个平台（Ubuntu、macOS、Windows）上构建
- ✅ 运行所有单元测试
- ✅ 进行代码质量检查
- ✅ 自动创建GitHub Release
- ✅ 上传各平台的编译产物
手动触发
- 访问仓库的 Actions 页面
- 选择 “C++ CI/CD Pipeline”
- 点击 “Run workflow” 按钮
- 选择分支并运行
创建版本发布
# 创建带版本号的tag
git tag v1.0.0
# 推送tag到远程
git push origin v1.0.0
这将触发CI/CD并创建一个正式版本的Release。
📊 项目状态
📚 更多文档
- CI/CD详细教程 - 深入了解GitHub Actions的工作原理
- Release发布指南 - 了解自动发布流程
🤝 贡献
欢迎提交Issue和Pull Request！
📄 许可证
本项目采用 MIT License 开源许可证。