GitLink CI/CD Demo Project

一个用于演示 GitLink CI/CD 流水线配置的示例项目。

项目结构

.
├── .github/
│   └── workflows/
│       ├── ci.yml          # 持续集成流水线
│       └── deploy.yml      # 持续部署流水线
├── src/
│   └── index.js            # 源代码
├── tests/
│   └── index.test.js       # 测试文件
├── .eslintrc.json          # ESLint 配置
├── tsconfig.json           # TypeScript 配置
├── package.json            # 项目依赖配置
└── README.md               # 项目说明文档

功能特性

• greet(name): 生成问候语
• add(a, b): 加法运算
• isValidEmail(email): 邮箱验证

CI/CD 流水线

持续集成 (CI)

触发条件：

• 推送到 main 或 develop 分支
• 创建或更新 Pull Request

执行任务：

1. 拉取代码
2. 设置 Node.js 环境
3. 安装依赖（带缓存）
4. ESLint 代码检查
5. TypeScript 类型检查
6. 单元测试（带覆盖率）
7. 上传覆盖率报告

持续部署 (CD)

触发条件：

• 推送到 main 分支
• 手动触发（可选 staging/production 环境）

执行任务：

1. 构建项目
2. 部署到预发布环境 (Staging)
3. 等待审批后部署到生产环境 (Production)

开发指南

安装依赖

npm ci

运行测试

npm test

代码检查

npm run lint
npm run type-check

构建项目

npm run build

环境变量与密钥

以下密钥需要在 GitLink Secrets 中配置：

密钥名称	用途
CODECOV_TOKEN	Codecov 覆盖率报告上传
PROD_API_KEY	生产环境 API 密钥

许可证

MIT License