GitHub Actions compatibility adapter

Keep existing cache-enabled, upload-artifact, and download-artifact actions unchanged when your CI runner supplies BoringCache GHA before the job.

Command: boringcache gha
Protocol: GitHub Actions Cache v2 and ArtifactService on the job's standard results-service environment
Action: mode: gha

How the adapter works

Keep existing action inputs

Cache actions keep keys and restore keys; artifact actions keep names, paths, retention, and archive behavior.

The runner supplies the service

A runner supervisor starts boringcache gha and installs its endpoint before provider actions launch. Cache bytes remain cache entries; build outputs become first-class Artifacts.

GitHub-hosted stays provider-backed

A workflow setup step cannot replace GitHub Runner's per-action endpoint. Use onboard, archive profiles, or native Artifact commands there.

Set up GitHub Actions compatibility

On an integrated runner, keep the workflow you already have. The runner supplies repository, ref, run, and job context and starts the service before any action process launches.

- uses: actions/upload-artifact@v4
  with:
    name: test-results
    path: test-results/

- uses: actions/download-artifact@v4
  with:
    name: test-results
    path: restored-results/

Before the first run

Use a CI runner integration whose supervisor starts boringcache gha before the job.
Keep cache path/key inputs and artifact path/name inputs on those existing actions.
On standard GitHub-hosted runners, provider actions remain GitHub-backed; use native BoringCache profiles or Artifact commands instead.

Use the same adapter in GitHub Actions

The runner provides this integration. Existing actions keep their paths, names, keys, restore keys, versions, and archive behavior without a BoringCache setup step.

.github/workflows/ci.yml

- uses: actions/upload-artifact@v4
  with:
    name: test-results
    path: test-results/

- uses: actions/download-artifact@v4
  with:
    name: test-results
    path: restored-results/

The runner decides whether these provider actions use BoringCache or GitHub. A workflow setup step alone cannot change that boundary on a standard GitHub-hosted runner.

GitHub Actions reference

Benchmarks

Availability depends on runner integration. Standard GitHub-hosted provider actions continue using GitHub storage.

All benchmarks

Tool reference

Check the tool's own reference when you need cache-key rules, build settings, or version-specific behavior.

All adapter commands

Compare every supported command, protocol, and Action mode in one place.

Adapter command index →

Need help or found something unclear? Open an issue or browse the CLI repo.