@actions/cache: optional S3 storage backend for self-hosted runners
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 28/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- aws, typescript
調査の方向性
Start by reading the @actions/cache implementation and the related discussion in actions/cache#679; the issue names no specific source files or tests. The proposed first step is to move the existing v1 and v2 implementations behind CacheBackend without changing behavior. Done means maintainers agree with the direction; implementing S3 and its tests are later, separate steps.
索引モデルが issue の本文から書いたものです。
説明
Describe the enhancement
Add an optional S3 storage backend to @actions/cache. The runner administrator turns it on with environment variables on the runner. Without them, nothing changes: the library keeps using the v1 or v2 cache service exactly as today.
On self-hosted runners in AWS, every cache restore and save goes to Azure Blob over the internet. That traffic leaves through a NAT gateway and is billed per GB. A large monorepo restoring 0.3–1.7 GB per job across hundreds of jobs a day turns into terabytes of NAT traffic, for data that could sit in a bucket in the same region and be read over a free S3 gateway endpoint.
Teams solve this today by forking actions/cache (runs-on/cache, tespkg/actions-cache, itchyny/s3-cache-action) or by running a cache server and binary-patching the runner to redirect ACTIONS_RESULTS_URL. The forks only cover workflows that switch uses: to the fork, so setup-* actions and anything else built on @actions/cache stays on the hosted service. None of the forks keep the hosted service's branch scoping, so any job holding the bucket credentials can overwrite the default branch's cache.
Related: #1051, actions/cache#679, #1695.
How the design answers the concerns raised in actions/cache#679
- "It should be a repo/org level setting and not a workflow setting." The backend is configured only through environment variables on the runner (
ACTIONS_CACHE_S3_BUCKET,ACTIONS_CACHE_S3_REGION, optionalACTIONS_CACHE_S3_PREFIXandACTIONS_CACHE_S3_ENDPOINT). There are no action inputs, so a workflow author can't redirect caches. It only applies to runners the administrator controls. - "How is the custom cache server endpoint secured?" No custom server is involved, and the runtime token is never sent anywhere new. The backend talks to S3 over HTTPS through the standard AWS SDK credential chain (instance role, IRSA, or credentials from
aws-actions/configure-aws-credentialswith GitHub OIDC). Access is governed by the bucket's IAM policy. - Cache management experience. Entries in S3 don't appear in the repository's cache UI or API. The bucket owner manages them, with a lifecycle rule for expiry. We'd document that limitation clearly.
Behaviour
- Object keys are
<prefix>/<owner>/<repo>/<ref>/<version>/<key>, whereversionis the existinggetCacheVersion()value, so compression method and cross-OS rules still apply. - Saves write only under the job's own ref. Restores look in the job's ref, then
GITHUB_BASE_REF, then the default branch, matching the hosted service's scoping. Since the ref is part of the object path, IAM can enforce it. For example, only a role trusted forref:refs/heads/mainmayPutObjectunder…/refs/heads/main/*. - Exact keys resolve with
HeadObject. Restore keys resolve by prefix withListObjectsV2, and the newest match wins. ACTIONS_CACHE_MODE,lookupOnly,CacheReadDeniedErrorandCacheWriteDeniedErrorkeep their current semantics. An S3AccessDeniedmaps to the matching denied error.- Uploads are multipart and parallel. Downloads use parallel ranged GETs.
- The AWS SDK is loaded lazily, only when the backend is configured.
Code Snippet
Runner environment, set by the administrator:
ACTIONS_CACHE_S3_BUCKET=my-runner-cache
ACTIONS_CACHE_S3_REGION=us-east-1
Library seam (first PR, no behaviour change):
export interface CacheBackend {
isAvailable(): boolean
restoreCache(paths: string[], primaryKey: string, restoreKeys?: string[], options?: DownloadOptions, enableCrossOsArchive?: boolean): Promise<string | undefined>
saveCache(paths: string[], key: string, options?: UploadOptions, enableCrossOsArchive?: boolean): Promise<number>
}
Additional information
Proposed sequence, each a separate PR:
- Refactor only: move the existing v1 and v2 implementations behind
CacheBackend, with no behaviour or public API change. A branch is ready to open if you're open to the direction. - Add the S3 backend with unit tests (mocked S3 client), including tests that the scoping matches the hosted service.
- In
actions/cache: bump@actions/cache, document the backend, and add an end-to-end workflow against a MinIO service container.
Per CONTRIBUTING, we'd like agreement on the direction before opening 2 and 3, and we're happy to write an ADR. Questions for maintainers:
- Is an administrator-configured S3 backend something you'd accept in
@actions/cache, or would you rather keep the library hosted-service-only? - If yes, is the extra dependency (
@aws-sdk/client-s3,@aws-sdk/lib-storage), loaded lazily, acceptable, or would you prefer the backend as a separate package that registers itself?
- 主要言語
- TypeScript
- スター
- 5.9k
- フォーク
- 1.8k
- 平均マージ
- 15分
- マージ済み PR(30日)
- 1
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
actions/toolkit のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
@actions/io: `mv(file, dest)` replaces `dest` when it is a symlink to a directory instead of moving into it対応中かも @bardrop が 7 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
@actions/exec: `exec(commandLine)` drops `""` arguments and trims trailing spaces of the last argument対応中かも @bardrop が 7 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
actions/toolkit#2565 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
actions/toolkit の issue をすべて見る
似ている issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 87/100
メンテナーはふだん 1 日以内に返信
-
🛠️ dette technique
難易度 2/5 1〜3時間 初心者へのやさしさ 61/100
betagouv/mon-entreprise#4752 · コメント 1 件 ·
メンテナーはふだん 5 日以内に返信
-
type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
franciscoBSalgueiro/en-croissant#1111 ·
メンテナーはふだん 2 日以内に返信
-
area/providers type/feature version/v2
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
anomalyco/opencode#64845 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信