Skip to content

README.md

Latest commit

 

History

History
70 lines (53 loc) · 1.63 KB

README.md

File metadata and controls

70 lines (53 loc) · 1.63 KB
Raw

setup-effigy

GitHub Action to download and cache the Effigy task runner.

Quick start

steps:
  - uses: actions/checkout@v4
  - uses: inflatable-cookie/setup-effigy@v1
    with:
      version: '0.2.7'
  - run: effigy test

Inputs

Name Required Default Description
version Yes — Effigy version to install (e.g. 0.2.7)
token No github.token GitHub token for downloading release assets

Outputs

Name Description
version The installed Effigy version
cache-hit Whether the binary was restored from cache (true/false)

Platform support

Runner OS Architecture Rust triple
Linux x86_64 x86_64-unknown-linux-gnu
Linux ARM64 aarch64-unknown-linux-gnu
macOS ARM64 (Apple Silicon) aarch64-apple-darwin
macOS x86_64 (Intel) x86_64-apple-darwin

Linux note: the downloaded GNU/Linux binaries are built on an Ubuntu 22.04 baseline and target glibc >= 2.35.

Caching

The downloaded binary is cached using actions/cache@v4 with key effigy-{version}-{triple}. On subsequent runs with the same version and platform, the binary is restored from cache instead of re-downloaded.

Full example

name: CI
on:
  pull_request:
  push:
    branches: [main]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: inflatable-cookie/setup-effigy@v1
        with:
          version: '0.2.7'
      - run: effigy test

License

MIT