Skip to content

docs(cache-server): document presigned uploads, streamed merges and SQLite WAL - #4

Merged
LouisHaftmann merged 2 commits into
masterfrom
docs/cache-server-rust-rewrite
Oct 26, 2026
Merged

LouisHaftmann merged 2 commits into
masterfrom
docs/cache-server-rust-rewrite

Conversation

@LouisHaftmann

@LouisHaftmann LouisHaftmann commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

📝 Summary

The cache server docs describe behavior that falcondev-oss/github-actions-cache-server#288 replaces: in-bucket merges, AWS SDK credential handling, Nitro env vars and nodejs_* metrics. This updates the pages to describe how the server works after that PR.

Important

Merge only once falcondev-oss/github-actions-cache-server#288 is released.

 getting-started.md
+  image: ~29 MB static binary on distroless, no shell, probe GET /health over HTTP
~  EAGER_MERGE: object storage streams parts through the server
~  CACHE_CLEANUP_OLDER_THAN_DAYS: a negative value fails startup
-  NITRO_PORT
+  PORT, HOST
~  MANAGEMENT_API_KEY: empty disables it; DELETE storage-locations answers 409 while downloading
 storage-drivers.md
+  Object storage: presigned part uploads, objects trusted for a minute
 storage-drivers/s3.md
~  credential sources; AWS_PROFILE not supported
+  lifecycle rule for incomplete multipart uploads
-  UploadPartCopy merge, Garage checksum troubleshooting
 storage-drivers/google-cloud-storage.md, azure-blob-storage.md
~  signing covers part uploads; no in-bucket merge
 database-drivers/sqlite.md
+  WAL with synchronous=normal
 metrics.md
-  nodejs_*, NITRO_CLUSTER_WORKERS warning

✅ Verification

  • pnpm exec prettier --check packages/gha-cache-server: passes.
  • vitepress build for packages/gha-cache-server: build complete.
  • Statements checked against refactor/rust-rewrite (src/config.rs, src/storage/object.rs, src/db.rs, src/metrics.rs, src/routes/management.rs, Dockerfile, ADR-0005/0009/0010) and object_store 0.14.2.

💥 Merge danger

Door: two-way

Blast Radius: docs

Merged before the release, the docs describe a server version users can't run yet.

🤖 Generated with Claude Code

LouisHaftmann and others added 2 commits October 26, 2026 14:22
Document the changes from falcondev-oss/github-actions-cache-server#288:
removed Node-only features and env vars, streamed eager merges on object
storage, presigned Part uploads, SQLite WAL, metrics and an upgrade guide.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@LouisHaftmann LouisHaftmann changed the title docs(cache-server): document the Rust rewrite and how to upgrade docs(cache-server): document presigned uploads, streamed merges and SQLite WAL Oct 26, 2026
@LouisHaftmann
LouisHaftmann merged commit 3e13107 into master Oct 26, 2026
@LouisHaftmann
LouisHaftmann deleted the docs/cache-server-rust-rewrite branch October 26, 2026 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant