setup-zola/README.md

setup-zola

This action sets up Zola static site generator in your GitHub Actions workflow. It supports downloading Zola from S3-compatible storage services including AWS S3, Cloudflare R2, MinIO, and others.

Usage

Basic usage:

- uses: my-org/setup-zola@v1
  with:
    version: "v0.20.0" # Optional, defaults to v0.20.0
    access_key: ${{ secrets.S3_ACCESS_KEY }} # Required
    secret_key: ${{ secrets.S3_SECRET_KEY }} # Required
    endpoint: "https://your-s3-endpoint.com" # Required (e.g., for R2: https://accountid.r2.cloudflarestorage.com)
    bucket: ${{ secrets.S3_BUCKET }} # Required

Example workflow

name: Build with Zola
on: push

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Setup Zola
        uses: my-org/setup-zola@v1
        with:
          version: "v0.20.0"
          access_key: ${{ secrets.S3_ACCESS_KEY }}
          secret_key: ${{ secrets.S3_SECRET_KEY }}
          endpoint: "https://your-s3-endpoint.com"
          bucket: ${{ secrets.S3_BUCKET }}
      - name: Build site
        run: zola build

License

MIT