Pipelight 项目使用教程

1. 项目介绍

Pipelight 是一个基于 Rust 开发的轻量级自动化流水线工具，旨在将 CI/CD 引入到最小的项目中。它支持在终端中使用，并且可以通过 TypeScript、TOML、HCL 和 YAML 等多种配置语言定义流水线。Pipelight 的设计目标是简化自动化任务的定义和管理，使得开发者可以更专注于代码本身。

2. 项目快速启动

安装

Pipelight 目前仅支持 Linux 系统。你可以通过以下命令安装：

# 使用 cargo 安装
cargo install pipelight

初始化项目

在项目根目录下创建一个默认的配置文件 pipelight.ts：

pipelight init

运行流水线

尝试运行默认的流水线：

pipelight run

查看日志

查看流水线的详细日志：

pipelight logs -vvvv

3. 应用案例和最佳实践

应用案例

假设你有一个前端项目，需要执行以下步骤：

1. 清理目录
2. 安装依赖
3. 运行 lint 检查
4. 构建项目
5. 将构建结果发送到远程服务器
6. 在远程服务器上重启 Nginx

你可以使用 Pipelight 定义一个流水线来完成这些任务。

最佳实践

在 pipelight.ts 文件中定义流水线：

const my_pipeline = pipeline("build website", () => [
  step("clean directory", () => [`rm -rf /dist`]),
  step("build", () => ["pnpm install", "pnpm lint", "pnpm build"]),
  step("send to host", () => [`scp -r /dist user@host:/path/to/deploy`]),
  step("do stuffs on host", () => [
    ssh("host", () => ["systemctl restart nginx"])
  ])
]);

export default {
  pipelines: [my_pipeline]
};

4. 典型生态项目

Pipelight 可以与以下生态项目结合使用，以增强其功能：

• Docker: 用于构建和运行容器化应用。
• Git: 用于版本控制和触发流水线。
• Nginx: 用于部署和运行 Web 应用。

通过这些工具的结合，Pipelight 可以实现从代码提交到生产部署的全自动化流程。