Skip to content

Update README with info on HA Cache Volumes #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 3, 2025
+9 −0
Merged

Update README with info on HA Cache Volumes #128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,15 @@ steps:
save: file
```

## Differences from Hosted Agents Cache Volumes

If you're using [Buildkite Hosted Agents](https://buildkite.com/docs/pipelines/hosted-agents), you also have access to [Hosted Agents Cache Volumes](https://buildkite.com/docs/pipelines/hosted-agents/cache-volumes). This cache plugin differs from Hosted Agents Cache Volumes in several ways:

- **Availability**: Works with both self-hosted agents and Hosted Agents (Hosted Agents Cache Volumes are exclusive to Hosted Agents)
- **Data persistence**: Provides reliable, durable storage via backends like S3 (Hosted Agents Cache Volumes should not be relied upon for durable data storage)
- **Retention**: Offers flexible retention policies (Hosted Agents Cache Volumes have a retention of 14 days from last use)
- **Cache invalidation**: Supports content-based invalidation using file manifests (Hosted Agents Cache Volumes use simple path-based caching)

## Dependencies
The plugin supports various backends and compression algorithms, and some environments (such as Docker containers based on Alpine Linux), may not have all of the dependencies needed to use the plugin out of the box. Ensure that the necessary dependencies are installed in the agent environment or container before using this plugin.

Expand Down