Ergomake 开源项目教程

Ergomake 开源项目教程

ergomakePreview environments on every pull request, for any stack.项目地址:https://gitcode.com/gh_mirrors/er/ergomake

1. 项目介绍

Ergomake 是一个开源项目，旨在为每个 Pull Request 自动生成预览环境。通过 Ergomake，您可以在容器中运行任何应用程序，包括后端数据库和队列。Ergomake 支持多仓库项目，并且可以生成包含多个服务的预览环境。

2. 项目快速启动

2.1 安装 Ergomake

首先，您需要登录到 Ergomake 平台，并选择您想要生成预览环境的组织。然后，点击 "Add Repo" 按钮，开始安装过程。

2.2 配置仓库访问权限

在安装过程中，Ergomake 会提示您授予其访问仓库的权限。请确保选择所有需要生成预览环境的仓库。

2.3 创建 docker-compose.yml 文件

在您的仓库根目录下创建一个 docker-compose.yml 文件，Ergomake 将使用此文件来生成预览环境。

version: "3.8"
services:
  web:
    build: .
    ports:
      - "8080:8080"
  api:
    build: ../my-backend-repo
    ports:
      - "3001:3001"
  database:
    image: mongo
    environment:
      MONGODB_INITDB_ROOT_USERNAME: username
      MONGODB_INITDB_ROOT_PASSWORD: password

2.4 提交 Pull Request

提交一个 Pull Request，并等待 Ergomake Bot 的评论。评论中将包含一个链接，指向所有在预览环境中运行的应用程序。

3. 应用案例和最佳实践

3.1 多仓库项目预览

Ergomake 支持多仓库项目，您可以在 docker-compose.yml 文件中引用其他仓库的路径，从而在一个预览环境中运行多个仓库的应用程序。

3.2 数据库和队列预览

通过在 docker-compose.yml 文件中定义数据库和队列服务，Ergomake 可以生成包含完整后端服务的预览环境，帮助开发者在开发过程中进行全面的测试。

4. 典型生态项目

4.1 GitHub Actions 集成

Ergomake 可以与 GitHub Actions 集成，自动在每次 Pull Request 时生成预览环境，并通过 GitHub 评论通知开发者。

4.2 Docker 生态

Ergomake 基于 Docker 技术，可以与 Docker 生态中的其他工具和服务无缝集成，如 Docker Compose、Docker Swarm 等。

通过以上步骤，您可以快速上手并使用 Ergomake 生成预览环境，提升开发效率和代码质量。

ergomakePreview environments on every pull request, for any stack.项目地址:https://gitcode.com/gh_mirrors/er/ergomake