plugins/s3-cache

drone-s3-cache

镜像概述

drone-s3-cache是Drone CI的官方插件，用于与Amazon S3或S3兼容的存储服务集成，实现CI/CD流程中的缓存管理。该镜像由https://github.com/drone-plugins/drone-s3-cache项目维护，通过Drone CI自动构建和推送。其核心功能是在构建过程中上传和下载缓存数据（如依赖包、构建产物等），从而加速重复构建，降低网络传输和计算资源消耗。

核心功能与特性

• 缓存管理：支持缓存的上传（rebuild）和下载（restore）操作，自动化管理CI流程中的缓存数据
• S3兼容性：兼容Amazon S3及所有S3 API兼容的存储服务（如MinIO、Ceph等）
• 灵活配置：支持通过环境变量或配置文件自定义缓存路径、缓存键、存储桶设置等
• Drone CI原生集成：作为Drone CI插件设计，可直接在Drone流水线配置中使用，无需额外适配

使用场景与适用范围

• 频繁构建项目：适用于需要频繁执行CI/CD流程的项目，通过缓存依赖（如npm、Maven、Gradle依赖）减少重复下载时间
• 大型构建产物：缓存编译后的中间产物或最终构建结果，避免重复构建耗时操作
• 多环境一致性：确保不同CI节点或构建环境使用相同的缓存数据，提高构建一致性
• S3存储用户：已使用Amazon S3或S3兼容存储服务的团队，可直接利用现有存储资源实现缓存管理

使用方法与配置说明

Drone CI流水线配置

在Drone CI的.drone.yml配置文件中，可通过plugins字段集成该插件。以下是典型使用示例：

基本配置（缓存下载+上传）

yaml
kind: pipeline
name: default

steps:
  # 缓存下载步骤
  - name: restore-cache
    image: docker.xuanyuan.run/plugins/s3-cache
    settings:
      access_key:
        from_secret: aws_access_key_id
      secret_key:
        from_secret: aws_secret_access_key
      bucket: my-drone-cache
      region: us-east-1
      path: cache
      key: ${DRONE_REPO_OWNER}-${DRONE_REPO_NAME}-${DRONE_COMMIT_BRANCH}
      restore: true

  # 构建步骤（例如安装依赖、编译等）
  - name: build
    image: docker.xuanyuan.run/node:18
    commands:
      - npm install
      - npm run build

  # 缓存上传步骤
  - name: rebuild-cache
    image: docker.xuanyuan.run/plugins/s3-cache
    settings:
      access_key:
        from_secret: aws_access_key_id
      secret_key:
        from_secret: aws_secret_access_key
      bucket: my-drone-cache
      region: us-east-1
      path: cache
      key: ${DRONE_REPO_OWNER}-${DRONE_REPO_NAME}-${DRONE_COMMIT_BRANCH}
      rebuild: true

配置参数说明

Docker运行示例

如需手动测试，可通过docker run命令直接运行镜像：

bash
# 下载缓存
docker run --rm \
  -e PLUGIN_ACCESS_KEY=AKIAEXAMPLEKEY \
  -e PLUGIN_SECRET_KEY=secret123456 \
  -e PLUGIN_BUCKET=my-drone-cache \
  -e PLUGIN_REGION=us-east-1 \
  -e PLUGIN_PATH=node_modules \
  -e PLUGIN_KEY=my-project-main \
  -e PLUGIN_RESTORE=true \
  -v $(pwd):/drone/src \
  docker.xuanyuan.run/plugins/s3-cache

# 上传缓存
docker run --rm \
  -e PLUGIN_ACCESS_KEY=AKIAEXAMPLEKEY \
  -e PLUGIN_SECRET_KEY=secret123456 \
  -e PLUGIN_BUCKET=my-drone-cache \
  -e PLUGIN_REGION=us-east-1 \
  -e PLUGIN_PATH=node_modules \
  -e PLUGIN_KEY=my-project-main \
  -e PLUGIN_REBUILD=true \
  -v $(pwd):/drone/src \
  docker.xuanyuan.run/plugins/s3-cache

注意事项

• 确保S3存储桶已存在且访问密钥具备正确权限（读权限用于restore，写权限用于rebuild）
• 缓存键（key）建议包含项目标识、分支名称或依赖版本等信息，避免不同场景下的缓存冲突
• 对于大型缓存，可通过path参数指定多个目录（用逗号分隔），如path: node_modules,dist
• 使用非AWS S3服务时，需通过endpoint参数指定服务地址，并确保region与服务配置一致