CI/CDDevOps【免费下载链接】woodpeckerWoodpecker is a simple, yet powerful CI/CD engine with great extensibility.项目地址https://gitcode.com/gh_mirrors/wo/woodpecker点击查看免费下载本篇指南面向首次接触 Woodpecker 的开发者带你从零走完激活仓库 → 编写 workflow 配置 → 推送触发流水线 → 接入插件的完整链路。读完本文你将掌握 Woodpecker v2.8 中 pipeline 配置文件的基本语法when过滤、steps、image、commands、webhook 与workspace的工作机制以及如何用插件和 Secret 复用常见任务。1. 激活仓库Repository Activation在 Woodpecker 中运行流水线的第一步是把你的代码仓库接入实例。在 Woodpecker UI 中进入仓库列表页面点击New repository即可看到来自你的代码托管平台GitHub、GitLab、Gitea 等Woodpecker 称之为 Forge上可被激活的仓库列表点击即可完成激活。需要注意的是激活仓库要求你拥有该仓库的Admin权限。原因是 Woodpecker 需要在仓库中注册一个webhook——它是 Woodpecker 感知代码仓库动态push、pull request、tag 等事件的关键通道。没有 webhookWoodpecker 就无法得知代码何时发生了变化也就无法触发流水线。从源码实现看仓库激活后服务器端通过 Forge 适配器server/forge/forge.go与各代码托管平台交互而后续流水线触发时配置文件的拉取正是由 Forge 的File/Dir接口完成见下文配置查找机制一节。2. 定义第一个 Workflow仓库激活完成后Woodpecker 会持续监听仓库变化。一旦检测到变更它就会去仓库中查找流水线配置文件。因此接下来我们要在仓库中创建第一个配置文件.woodpecker/my-first-workflow.yamlwhen: - event: push branch: main steps: - name: build image: debian commands: - echo This is the build step - echo binary-data-123 executable - name: a-test-step image: golang:1.16 commands: - echo Testing ... - ./executable这份配置做了什么逐段拆解定义了一个 workflow 文件my-first-workflow.yaml。Woodpecker 的流水线pipeline由 workflow 构成workflow 定义在 YAML 文件中。通过when段添加了触发过滤条件该 workflow 只在main分支上发生 push 事件时执行 when: - event: push branch: main ...when是一个条件列表满足其中任意一条且一条内的所有子条件都成立即会执行。event可选值包括push、pull_request、tag、deployment等branch用于限定目标分支。关于when的完整用法如repo、status、event等子条件见 workflow 语法文档 中的 Conditional Execution 章节。定义了两个步骤build和a-test-step。步骤按定义顺序串行执行因此build先执行然后才是a-test-step。build步骤使用debian镜像输出一行日志并把字符串binary-data-123写入名为executable的文件模拟构建产物a-test-step步骤使用golang:1.16镜像执行./executable来测试上一步的产物。使用任意你权限范围内的镜像image字段并不局限于官方镜像。凡是你能访问到的 registry如 Docker Hub中的镜像都可以使用包括你所在组织的私有镜像。例如steps: - name: build - image: debian image: mycompany/image-with-awscli commands: - aws helpWoodpecker 支持任意合法 Docker 镜像引用格式例如golang、golang:1.16、library/golang:1.16、index.docker.io/library/golang:1.16等。如果你的镜像托管在非默认的私有 registry还需要为仓库配置对应的 registry 凭据参见 registries 文档。配置查找机制为什么是.woodpecker/细心的读者会注意到官方约定把配置文件放在.woodpecker/目录下但也可以放在.woodpecker.yaml或.woodpecker.yml。这个优先级顺序在仓库源码中是可以直接验证的shared/constant/constant.go 定义了默认查找顺序var DefaultConfigOrder []string{ .woodpecker/, .woodpecker.yaml, .woodpecker.yml, }对应的查找逻辑位于 server/services/config/forge.goWoodpecker 按此顺序依次尝试命中第一个可用配置即返回如果用户通过仓库设置自定义了配置路径则优先使用用户指定的路径。其单元测试 server/services/config/forge_test.go 验证了多种场景——例如.woodpecker/目录下存在多个 YAML 文件时全部纳入、.woodpecker.yaml优先于.woodpecker.yml、目录中的非配置文件如image.png、notes.txt会被过滤掉等。因此把你的第一个配置文件命名为.woodpecker/my-first-workflow.yaml是完全可以被默认查找逻辑识别的若仓库同时存在.woodpecker/目录与根目录的.woodpecker.yaml目录方式优先。3. 推送文件触发第一条流水线把上述文件推送到仓库后webhook 会把 push 事件通知给 Woodpecker 服务器服务器随即执行你的第一条流水线。在 Woodpecker UI 中进入仓库的Pipelines板块即可查看流水线的执行情况包括每个步骤的状态、日志输出与耗时。在流水线视图中你可能会注意到在执行你自己的步骤之前还有一个名为clone的步骤。该步骤负责把仓库源码克隆到名为workspace的目录中这个目录在所有步骤之间共享。这正是上面示例能跑通的关键workspace目录在整条流水线中持久存在因此——第一个步骤可以使用源码构建应用第二个步骤拿到的是同一个 workspace可以直接使用上一步构建出的二进制文件进行测试。这也解释了 Woodpecker 的一个核心特性文件变更是增量累积的。clone 步骤在 workflow 开始处执行后续所有步骤挂载同一份卷任何步骤对文件的修改都会保留给后续步骤参见 workflow 语法文档 的 File changes are incremental 小节。从源码看默认的 clone 插件由 shared/constant/constant.go 定义默认为docker.io/woodpeckerci/plugin-git:2.10.1并可通过WOODPECKER_DEFAULT_CLONE_PLUGIN环境变量在运行时替换。小贴士推送前本地验证在正式推送之前如果你本机装有woodpecker-cli且已配置受支持的执行后端如 Docker还可以先在本地运行 workflow 来验证语法与命令输出woodpecker-cli exec .woodpecker/my-first-workflow.yaml本地执行基于 cli/exec/exec.go 实现它复用 pipeline 前端的解析与编译逻辑非常适合在编辑阶段快速检查when条件、命令输出和元数据是否正确。4. 使用插件复用常见任务在实际项目中总有一些任务需要在每个项目里重复执行例如部署到 Kubernetes、发送 Slack 通知、上传产物到对象存储等。为此 Woodpecker 提供了插件Plugin机制你可以使用官方与社区插件也可以自行创建插件。例如希望在流水线结束后发送 Slack 通知可以在 pipeline 中追加一个 Slack 插件步骤--- - name: notify me on Slack image: plugins/slack settings: channel: developers username: woodpecker password: from_secret: slack_token when: status: [success, failure] # 无论成功还是失败都会执行该步骤这段配置涉及三个要点settings段用于配置插件。插件的每个settings项都会以PLUGIN_前缀的环境变量形式注入插件容器例如channel对应PLUGIN_CHANNEL插件据此读取配置并执行行为。from_secret用于向插件注入密钥。password的值来自一个名为slack_token的 Secret该 Secret 需要在 Woodpecker UI 中预先定义。Secret 存储于 Woodpecker 的集中式密钥库中与 YAML 配置分离避免敏感信息落入版本库。更多细节参见 secrets 文档v2.8 中既支持在secrets段声明后以环境变量形式使用注意$需要转义为$$以避免参数预处理也支持from_secret这种更推荐的写法同时 Secret 支持仓库级、组织级、全局级三个层级并可用镜像过滤器限制其可用范围。步骤级when条件。与文件顶部针对整个 workflow 的when不同每个步骤也可以有自己的when段用于定义该步骤的执行时机。示例中的status: [success, failure]意味着无论流水线整体成功还是失败通知步骤都会执行——这与普通步骤失败即终止整条流水线的行为不同是典型的通知类步骤写法。关于插件的更多信息插件清单、如何编写自己的插件等参见 插件总览。5. 下一步深入学习至此你已经掌握了 Woodpecker pipeline 的基本创建流程。接下来可以沿着两个方向深入Workflow 语法workflow 语法文档 完整覆盖image、commands、environment、secrets、failure: ignore、when条件、并行depends_on、服务容器services等全部字段是你编写复杂流水线的核心参考插件体系插件总览 介绍官方与社区插件生态创建插件指南 则教你把自己的重复任务封装成可复用插件。这两份文档与本文共同构成了 Woodpecker v2.8 流水线开发的完整入门路径。赞分享CI/CDDevOps【免费下载链接】woodpeckerWoodpecker is a simple, yet powerful CI/CD engine with great extensibility.项目地址https://gitcode.com/gh_mirrors/wo/woodpecker点击查看免费下载相关推荐Woodpecker 入门实战从激活仓库到跑通第一条 CI/CD 流水线Woodpecker 入门实战从激活仓库到跑通第一条 CI/CD 流水线 本文是 Woodpecker CI/CD 引擎的零基础入门指南以“创建你的第一条流CI/CDDevOpsWoodpecker CI/CD 入门指南从核心概念到第一条流水线Woodpecker CI/CD 入门指南从核心概念到第一条流水线 Woodpecker 是一个轻量、简单、快速且具备良好扩展性的开源 CI/CD 引擎适合CI/CDDevOpsSeleniumBase 构建 Selenium Grid 分布式测试集群Hub/Node 部署与远程并行执行完全指南SeleniumBase 构建 Selenium Grid 分布式测试集群Hub/Node 部署与远程并行执行完全指南 SeleniumBase 内置了对 SCI/CDDevOps上一篇dsh-market 主题市场使用指南DSH 主题一键安装、即时生效与免重启切换下一篇Webamp 多曲目初始化实战基于 CDN 快速构建多轨浏览器播放器创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考