Stage.ci 项目教程

Stage.ci 项目教程

stage-ci Automatic deploy previews for your PRs using zeit.co/now. 项目地址: https://gitcode.com/gh_mirrors/st/stage-ci

1. 项目介绍

Stage.ci 是一个用于自动部署预览的开源项目，特别适用于使用 Zeit 的 Now 服务的 Pull Request（PR）。它能够为每个 PR 自动生成实时部署预览环境，方便开发者在合并代码前进行测试和审查。

2. 项目快速启动

2.1 环境准备

• Node.js 6.6.0 及以上版本
• GitHub 或 GitLab 账户
• Zeit 账户

2.2 安装依赖

首先，克隆项目到本地：

git clone https://github.com/zpnk/stage-ci.git
cd stage-ci

然后，安装项目依赖：

yarn install

2.3 配置环境变量

根据你使用的平台（GitHub 或 GitLab），生成相应的 API 令牌，并设置环境变量：

export GITHUB_TOKEN=your_github_token
export GITLAB_TOKEN=your_gitlab_token
export ZEIT_API_TOKEN=your_zeit_api_token

如果需要 Papertrail 日志记录，设置以下环境变量：

export PAPERTRAIL_HOST=logs.papertrailapp.com
export PAPERTRAIL_PORT=1234

2.4 启动服务

启动服务器：

yarn dev

2.5 测试 GitHub 集成

安装 ngrok 或其他本地隧道工具，并将其指向端口 3000：

ngrok http 3000

在 GitHub 上设置一个测试仓库，并配置一个 webhook，使用 ngrok 提供的 URL。选择“Let me select individual events”并勾选“Pull request”事件。生成一个长且安全的 webhook 密钥，并设置环境变量：

export GITHUB_WEBHOOK_SECRET=your_webhook_secret

打开一个 PR 以触发 webhook，检查部署预览是否成功。

3. 应用案例和最佳实践

3.1 应用案例

Stage.ci 可以用于任何需要频繁部署和测试的项目，特别是在团队协作开发中。例如，一个前端团队可以使用 Stage.ci 为每个 PR 生成一个实时预览环境，方便设计师和产品经理进行审查。

3.2 最佳实践

• 安全配置：确保所有 API 令牌和 webhook 密钥都是安全的，不要在公共场合分享。
• 日志记录：使用 Papertrail 或其他日志服务记录所有部署和错误信息，便于排查问题。
• 自动化测试：在部署预览环境中集成自动化测试，确保每次部署的质量。

4. 典型生态项目

• Zeit Now：Stage.ci 的核心依赖，用于生成实时部署预览。
• GitHub Actions：可以与 Stage.ci 结合使用，进一步自动化 CI/CD 流程。
• Papertrail：用于日志记录，帮助监控和排查部署过程中的问题。

通过以上步骤，你可以快速上手并使用 Stage.ci 项目，为你的开发流程带来便利。

stage-ci Automatic deploy previews for your PRs using zeit.co/now. 项目地址: https://gitcode.com/gh_mirrors/st/stage-ci