meltwater/drone-cache

Drone构建缓存插件

概述

Drone构建缓存插件是一个专为Drone CI/CD流程设计的工具，用于在多次构建之间缓存工作区文件，避免重复下载依赖、编译代码等耗时操作，从而显著缩短构建时间，提升CI/CD流水线效率。

核心功能与特性

• 工作区文件缓存: 支持指定路径的文件或目录缓存，保留构建过程中的中间产物
• 跨构建共享: 在后续构建中自动恢复缓存内容，减少重复操作
• 灵活的缓存策略: 通过自定义缓存键实现版本化管理，支持基于文件校验和、分支等动态生成缓存标识
• 轻量级集成: 作为Drone插件无缝融入现有流水线，配置简单

使用场景

• 前端项目: 缓存node_modules依赖目录，避免每次构建重复安装npm包
• 后端项目: 缓存依赖库、编译后的二进制文件或中间产物
• 移动应用: 缓存Gradle/Maven依赖、CocoaPods库等
• 任何重复构建场景: 适用于需要频繁执行且依赖稳定的Drone流水线

使用方法

Drone流水线配置示例

在.drone.yml中添加缓存步骤，通常包含"恢复缓存"和"保存缓存"两个阶段：

yaml
kind: pipeline
name: default

steps:
  # 恢复缓存步骤
  - name: restore-cache
    image: drone-cache-plugin
    settings:
      path: node_modules  # 需要缓存的目录路径
      key: ${DRONE_REPO_NAME}-${DRONE_COMMIT_BRANCH}-{{ checksum "package-lock.json" }}  # 缓存唯一标识
      restore: true  # 启用恢复缓存功能

  # 构建步骤（示例为前端构建）
  - name: build
    image: node:18
    commands:
      - npm install  # 若缓存存在，此步骤会大幅加速
      - npm run build

  # 保存缓存步骤
  - name: save-cache
    image: drone-cache-plugin
    settings:
      path: node_modules  # 与恢复缓存的路径保持一致
      key: ${DRONE_REPO_NAME}-${DRONE_COMMIT_BRANCH}-{{ checksum "package-lock.json" }}  # 与恢复缓存的key保持一致
      save: true  # 启用保存缓存功能

配置参数说明

环境变量支持

插件可直接使用Drone提供的内置环境变量，常用变量包括：

• DRONE_REPO_NAME: 当前仓库名称
• DRONE_COMMIT_BRANCH: 当前构建分支
• DRONE_BUILD_NUMBER: 构建编号
• DRONE_COMMIT_SHA: 提交哈希值

这些变量可用于动态生成缓存键，确保不同分支、不同版本的缓存隔离。