跳到主要内容

术语

词汇表​

  • Woodpecker CI: Woodpecker 项目的名称。
  • Woodpecker: 一个开源工具，在您的代码上执行[管道][Pipeline]。
  • 服务器: Woodpecker 的组件，处理来自代码托管平台的 webhooks，编排代理，并发送状态。它还提供用于管理和配置的 API 和 Web UI。
  • 代理: Woodpecker 的组件，使用特定后端（例如 Docker、Kubernetes、[本地][Local]）执行[管道][Pipeline]（具体来说是一个或多个[工作流][Workflow]）。它通过 GRPC 连接到服务器。
  • CLI: Woodpecker 命令行界面（CLI）是一个终端工具，用于管理服务器、本地执行管道进行调试/测试，并执行管道检查等任务。
  • [管道][Pipeline]: 在代码上执行的[工作流][Workflow]序列。管道由事件触发。
  • [工作流][Workflow]: 作为[管道][Pipeline]一部分执行的步骤和服务序列。工作流由 YAML 文件表示。每个工作流都有自己的隔离[工作空间][Workspace]，并且通常还有其他资源，如共享网络（docker）。
  • 步骤: [工作流][Workflow]中的各个命令、动作或任务。
  • 代码: 指由[代码托管平台][Forge]使用的版本控制系统跟踪的文件。
  • 仓库: 存储代码的位置的简称。
  • [代码托管平台][Forge]: 托管仓库的托管平台或服务。
  • [工作空间][workspace]: [工作流][Workflow]所有步骤之间共享的文件夹，包含仓库和来自先前步骤的所有生成数据。
  • [事件][Event]: 触发[管道][Pipeline]执行，如[代码托管平台][Forge]事件如 push，或从 UI 手动触发 manual。
  • 提交: 代码的已定义状态，通常与 Git 等版本控制系统相关联。
  • [矩阵][Matrix]: 一个配置选项，允许为矩阵中的每个值执行[工作流][Workflow]。
  • 服务: 服务是从[工作流][Workflow]开始到结束执行的步骤。它可以通过网络按名称从同一[工作流][Workflow]中的其他步骤访问。
  • [插件][Plugin]: 插件是为[工作流][Workflow]中的步骤提供预定义动作或命令的扩展。它们可以通过设置进行配置。
  • 容器: 执行命令的轻量级隔离环境。
  • YAML 文件: 用于定义和配置[工作流][Workflow]的文件格式。
  • 依赖: [工作流][Workflow]可以相互依赖，如果可能，它们将并行执行。
  • 状态: 状态指步骤或[工作流][Workflow]执行后的结果，由内部命令退出代码确定。在[工作流][Workflow]结束时，其状态会发送到[代码托管平台][Forge]。
  • 服务扩展: Woodpecker 内部服务的一些部分，如密钥存储或配置获取器，可以通过服务扩展进行替换。
  • 任务: 任务是当前在任务队列中等待执行的[工作流][Workflow]。

Woodpecker 架构​

Woodpecker 架构

管道、工作流和步骤​

管道、工作流和步骤之间的关系

约定​

有时有多个术语可以用来描述某件事。本节列出了在 Woodpecker 中使用的首选术语：

  • 环境变量 *_LINK 应称为 *_URL。在代码中使用 URL() 而不是 Link()
  • 使用术语 管道 而不是之前的 构建
  • 使用术语 步骤 而不是之前的 作业
  • 对通常不需要用户设置的高级环境变量使用前缀 WOODPECKER_EXPERT_