本项目包含两个GitHub Actions工作流配置文件:
触发条件:
- 推送到
main或develop分支 - 向
main分支提交Pull Request
功能:
- 构建和测试 - 在多个Node.js版本(18.x, 20.x)上构建项目
- 代码质量检查 - 进行TypeScript类型检查和依赖安全检查
- 自动部署 - 当代码推送到main分支时,自动部署到GitHub Pages
如果你想使用自动部署到GitHub Pages功能,需要:
- 进入仓库的 Settings > Pages
- 在 Source 中选择 GitHub Actions
- 确保你的仓库是公开的,或者有GitHub Pro/Team账户
你可以根据项目需要修改以下配置:
- Node.js版本: 在
ci.yml中修改matrix.node-version - 分支策略: 修改
on.push.branches和on.pull_request.branches - 部署目标: 如果不需要GitHub Pages部署,可以删除
deployjob
如果你的项目使用了以下工具,可以取消相应的注释:
# ESLint检查
- name: 运行ESLint
run: pnpm exec eslint src/ --ext .ts,.tsx
# Prettier格式检查
- name: 检查代码格式
run: pnpm exec prettier --check "src/**/*.{ts,tsx,js,jsx}"
# 单元测试
- name: 运行测试
run: pnpm test工作流运行状态可以在仓库的 Actions 标签页中查看。每次推送代码或创建PR时,相应的工作流会自动运行。