actions / actions/cache

More granular read timeout

Open
#1,170 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5.6k
Forks
1.6k
PR merge metrics
No merged PRs in 30d

Description

We are currently affected by cache read timeouts. The pattern is similar to https://github.com/actions/cache/issues/1141: cache download starts normally and then download stops completely.

There is a SEGMENT_DOWNLOAD_TIMEOUT_MINS environment variable but it only affects a full segment (1 or 2 GB).

Would it be possible to have more granular control over the timeout? Maybe something like:

  • SEGMENT_CONNECT_TIMEOUT_SECS: Timeout if it takes more than X seconds to establish the connection to the remote cache.
  • SEGMENT_REAT_TIMEOUT_SECS: Timeout if there is more than X seconds without a single byte being read on the wire.
  • SEGMENT_DOWNLOAD_TIMEOUT_MINS: keep current behaviour. Timeout if it takes more than X minutes to download a segment.

This way, we don't have to wait 10min if a relatively small entry times out

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing SEGMENT_DOWNLOAD_TIMEOUT_MINS behavior and the cache segment restore timeout guidance in tips-and-workarounds.md, then compare the failure pattern with actions/cache#1141. Define how connection, idle-read, and full-segment timeouts should interact, and verify that each proposed environment variable has documented behavior and coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, typescript
Domain
ci-cd
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.