Fly PR Review Apps 使用教程
项目介绍
Fly PR Review Apps 是一个 GitHub Action,用于在 Fly.io 上自动部署 Pull Request 以供审查。这个 Action 封装了 Fly.io CLI,使得开发者可以在不设置显式 staging 环境的情况下测试分支上的更改。该 Action 会自动创建、部署和销毁 Fly 应用。只需为 FLY_API_TOKEN 设置一个 Action Secret 即可。
项目快速启动
安装步骤
-
克隆项目仓库
git clone https://github.com/superfly/fly-pr-review-apps.git cd fly-pr-review-apps
-
设置 GitHub Secrets
- 在 GitHub 仓库的 Settings 页面中,添加一个新的 Secret
FLY_API_TOKEN
,值为你的 Fly.io API Token。
- 在 GitHub 仓库的 Settings 页面中,添加一个新的 Secret
-
创建 GitHub Actions Workflow
- 在项目根目录下创建
.github/workflows/deploy.yml
文件,内容如下:
name: Deploy PR Review Apps on: pull_request: types: [opened, synchronize, reopened] jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v2 - name: Deploy app uses: superfly/fly-pr-review-apps@1.0.0 with: name: pr-${{ github.event.number }}-myapp-app env: FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
- 在项目根目录下创建
-
提交并推送更改
git add . git commit -m "Setup Fly PR Review Apps GitHub Action" git push
应用案例和最佳实践
应用案例
Fly PR Review Apps 可以用于以下场景:
- 前端开发:在 Pull Request 中自动部署前端应用,方便团队成员进行视觉审查。
- 后端开发:自动部署后端服务,进行 API 测试和集成测试。
- 全栈应用:自动部署前后端应用,进行端到端测试。
最佳实践
- 环境隔离:确保每个 Pull Request 都有独立的环境,避免环境冲突。
- 自动化测试:在部署后自动运行测试脚本,确保应用的稳定性和可靠性。
- 清理资源:在 Pull Request 关闭后自动销毁相关资源,避免资源浪费。
典型生态项目
Fly PR Review Apps 可以与以下生态项目结合使用:
- Fly.io:用于部署和管理应用的基础设施。
- GitHub Actions:用于自动化 CI/CD 流程。
- Docker:用于容器化应用,便于部署和管理。
通过结合这些生态项目,可以构建一个完整的自动化部署和测试流程,提高开发效率和应用质量。