Skip to content

README.md

Latest commit

 

History

History
167 lines (114 loc) · 5.66 KB

README.md

File metadata and controls

167 lines (114 loc) · 5.66 KB
Raw

Setup Bazel Cache

A GitHub Action for Linux workflows. It restores and saves Bazelisk, Bazel disk, and downloaded repository caches. It can also cache large extracted external repositories and report cache reuse. It does not configure a remote cache.

Use it when CI needs to reuse dependency downloads, preserve cache generations, or show whether Bazel reused build and test results.

Quick start

Run checkout first, then add the action before your Bazel commands:

steps:
  - uses: actions/checkout@<sha>

  - uses: eclipse-score/cicd-actions/setup-bazel-cache@<sha>
    with:
      disk-cache-key: ${{ github.job }}

  - run: bazel test //...

Keep disk-cache-key stable between runs. Add matrix values when jobs need separate disk caches. github.job can be used to share a cache across callers of the same reusable workflow.

Inputs

Cache identity and publishing

  • disk-cache-key

    • Options: Required string of 1–400 printable characters, without commas.

    Use a stable value to identify the disk cache for this job. Add matrix values when jobs need separate caches. For a matrix example, see Use the action in a build matrix.

  • cache-save-branch-patterns

    • Options: Empty (default), or newline-separated branch names and glob patterns.

    Empty allows only the repository's default branch to save. Set patterns to allow other branches, and include the default branch if it should remain allowed; pull-request refs and tags cannot save caches.

  • token

    • Options: ${{ github.token }} (default) or another GitHub token.

    Supply a token with actions: write if the action should remove obsolete disk or repository cache generations after an upload. Uploads work without that permission.

Cache families

Disk cache

  • disk-cache-restore

    • Options: auto (default), true, false.

    auto skips the existing cache when the module lockfile changed and this run may save. true always attempts restore; false skips it.

  • disk-cache-save

    • Options: true (default), false.

    Set false to prevent disk-cache uploads from this job. Saving is still limited by the branch policy.

Downloaded repository cache

  • repository-cache-restore

    • Options: auto (default), true, false.

    auto skips the old cache when MODULE.bazel.lock changed and this run may save, so the next generation starts with downloads for the new dependencies. true always attempts restore; false skips it. This setting does not control the separate extracted-repository cache. See automatic restore behavior.

  • repository-cache-save

    • Options: auto (default), true, false.

    auto seeds an empty or lockfile-reset cache and saves after the configured growth threshold. true saves every eligible non-empty run; false disables uploads.

  • repository-cache-growth-threshold

    • Options: Integer from 0 to 100 (default: 10).

    Used when repository-cache-save is auto. Set it to 0 to save after any positive growth, including small additions from flaky downloads.

Bazel version cache

  • bazelisk-cache-restore

    • Options: true (default), false.

    Set false to download the selected Bazel version again instead of restoring it from cache.

  • bazelisk-cache-save

    • Options: true (default), false.

    Set false to stop saving downloaded Bazel versions for later runs.

Extracted external repositories

  • external-cache-restore

    • Options: true (default), false.

    Set false to skip restoring large extracted repositories under Bazel's output base.

  • external-cache-save

    • Options: true (default), false.

    Set false to stop saving extracted repositories. These caches are saved only after a successful job.

Reports and profiling

  • report-cache-hits

    • Options: true (default), false.

    Set false to disable build/action cache reporting for build, run, test, and coverage invocations.

  • report-test-cache-hits

    • Options: true (default), false.

    Set false to disable test-result reporting for test and coverage. Reporting does not enable Bazel's test-result cache.

  • report-cache-step-summary

    • Options: true, false (default).

    Set true to also write enabled reports to the GitHub Actions step summary.

  • enable-profiling

    • Options: auto (default), true, false.

    auto captures profiles when Actions debug logging is enabled; true captures profiles on every run and false disables profiling. Captured profiles are uploaded as a job artifact.

The reference covers detailed behavior and input interactions.

Outputs

Output Meaning
cache-save-branch-evaluated true when this ref is allowed to save caches, otherwise false.
bazelisk-cache-restored true when a Bazelisk cache was restored, otherwise false.
disk-cache-restored true when a disk cache was restored, otherwise false.
repository-cache-restored true when a downloaded repository cache was restored, otherwise false.
external-cache-restored true when the manifest and every repository it lists were restored, otherwise false.

Choose a guide

  • How-to: use caches in a build matrix, warm a shared repository cache, and allow selected branches to publish.
  • Reference: input defaults, accepted values, outputs, and permissions.
  • Explanation: how cache restore and save decisions work, what reports measure, and how cache storage is managed.