# Woodpecker sccache Plugin

A [Woodpecker CI](https://woodpecker-ci.org/) plugin that integrates [sccache](https://github.com/mozilla/sccache) (Mozilla's compiler cache) with your CI/CD pipeline to speed up compilation times.

## Description

This plugin configures sccache with S3 backend integration, allowing your CI/CD pipeline to cache compilation artifacts between builds.

## Features

- Easy integration with Woodpecker CI
- S3-compatible storage support (AWS S3, MinIO, etc.)
- Compatible with Rust, C/C++, and other sccache-supported languages
- Environment sharing between pipeline steps

## Usage

Add the plugin to your Woodpecker pipeline:

```yaml
steps:
  cache:
    image: sebastinez/plugin-sccache:latest
    volumes:
      - sccache:/sccache_data
    settings:
      s3-endpoint: https://your-s3-endpoint.com
      s3-bucket: your-cache-bucket
      s3-key-prefix: your-project-name
      s3-access_key:
        from_secret: s3_access_key
      s3-secret_key:
        from_secret: s3_secret_key

  build:
    image: your-build-image
    volumes:
      - sccache:/sccache_data
    commands:
      - export PATH="/sccache_data:$PATH"
      - source .sccache
      - cargo build --release
```

## Settings

| Parameter           | Description                                          | Default     |
|:--------------------|:-------------------------------------------------------------------|
| `s3-endpoint`       | S3-compatible endpoint URL                           |             |
| `s3-bucket`         | S3 bucket name                                       |             |
| `s3-access-key`     | S3 access key                                        |             |
| `s3-secret-key`     | S3 secret key                                        |             |
| `region`            | AWS region                                           | `auto`      |
| `key-prefix`        | Key prefix in S3 bucket                              | `sccache`   |
| `s3-no-credentials` | S3 no credentials                                    | `false`     |
| `log-level`         | Sccache log level (error, warn, info, debug, trace)  | `info`      |

## How It Works

1. The cache step:
   - Configures the sccache server with the desired storage solution
   - Creates environment variables in `.sccache` for subsequent steps

2. Your build steps:
   - Source the environment file to use the same sccache configuration
   - Run compilation commands that automatically use sccache

Sccache automatically handles caching compiler outputs to and from S3 during your build process.

## Building the Plugin

To build the plugin locally:

```bash
docker build -t yourusername/woodpecker-sccache-plugin:latest .
```