📚 Document automatically enabled cache on GitHub-hosted runners (#302)
Some checks failed
Release Drafter / ✏️ Draft release (push) Failing after 13s
test-cache / test-setup-cache (false, ubuntu-latest) (push) Successful in 21s
Check dist/ / check-dist (push) Successful in 1m5s
test-cache / test-setup-cache (true, ubuntu-latest) (push) Successful in 38s
test-cache / test-setup-cache-dependency-glob (push) Failing after 5s
test-cache / test-restore-cache-dependency-glob (push) Has been skipped
test-cache / test-setup-cache-requirements-txt (push) Successful in 41s
test-cache / test-no-python-version (push) Successful in 1m1s
test / test-default-version (ubuntu-latest) (push) Successful in 18s
test / build (push) Successful in 1m18s
test / test-specific-version (0.3.0) (push) Successful in 16s
test / test-specific-version (0.3.2) (push) Successful in 13s
test / test-specific-version (0.3) (push) Failing after 53s
test / test-specific-version (>=0.3.0) (push) Failing after 3s
test / test-specific-version (0.3.x) (push) Successful in 24s
test / test-semver-range (push) Successful in 16s
test / test-pyproject-file-version (push) Successful in 10s
test / test-uv-file-version (push) Successful in 10s
test / test-checksum (4d9279ad5ca596b1e2d703901d508430eb07564dc4d8837de9e2fca9c90f8ecd, ubuntu-latest) (push) Successful in 14s
test / test-with-explicit-token (push) Successful in 16s
test / test-uvx (push) Successful in 22s
test / test-tool-install (ubuntu-latest) (push) Successful in 18s
test / test-python-version (macos-latest) (push) Successful in 46s
test / test-python-version (ubuntu-latest) (push) Successful in 52s
test / test-musl (push) Failing after 6s
test / test-malformed-pyproject-file-fallback (push) Successful in 22s
test / test-python-version (windows-latest) (push) Successful in 48s
test-cache / test-setup-cache (auto, ubuntu-latest) (push) Failing after 6m48s
CodeQL / Analyze (TypeScript) (push) Failing after 6m48s
test-cache-windows / test-setup-cache (push) Has been cancelled
test-cache / test-setup-cache (auto, selfhosted-ubuntu-arm64) (push) Has been cancelled
test-cache / test-setup-cache (false, selfhosted-ubuntu-arm64) (push) Has been cancelled
test-cache / test-setup-cache (true, selfhosted-ubuntu-arm64) (push) Has been cancelled
test-cache / test-setup-cache-local (push) Has been cancelled
test-cache / test-tilde-expansion-cache-local-path (push) Has been cancelled
test-cache / test-tilde-expansion-cache-dependency-glob (push) Has been cancelled
test-windows / test-default-version (push) Has been cancelled
test / test-default-version (macos-14) (push) Has been cancelled
test / test-default-version (macos-latest) (push) Has been cancelled
test / test-checksum (a70cbfbf3bb5c08b2f84963b4f12c94e08fbb2468ba418a3bfe1066fbe9e7218, macos-latest) (push) Has been cancelled
test / test-tool-install (macos-14) (push) Has been cancelled
test / test-tool-install (macos-latest) (push) Has been cancelled
test / test-tool-install (windows-latest) (push) Has been cancelled
test / test-tilde-expansion-tool-dirs (push) Has been cancelled
test-cache-windows / test-restore-cache (push) Has been cancelled
test-cache / test-restore-cache (auto, selfhosted-ubuntu-arm64) (push) Has been cancelled
test-cache / test-restore-cache (auto, ubuntu-latest) (push) Has been cancelled
test-cache / test-restore-cache (false, selfhosted-ubuntu-arm64) (push) Has been cancelled
test-cache / test-restore-cache (false, ubuntu-latest) (push) Has been cancelled
test-cache / test-restore-cache (true, selfhosted-ubuntu-arm64) (push) Has been cancelled
test-cache / test-restore-cache (true, ubuntu-latest) (push) Has been cancelled
test-cache / test-restore-cache-requirements-txt (push) Has been cancelled
test-cache / test-restore-cache-local (push) Has been cancelled
test-cache / cleanup-tilde-expansion-tests (push) Has been cancelled
Update known checksums / build (push) Failing after 38s

Default behavior of caching is "auto", meaning it's enabled on
github-hosted runners. This wasn't obvious at first, and I was wondering
why I was getting warnings about cache when I didn't even have it
enabled. Hopefully this small documentation update will save some
headaches (for those who read the docs at least 😉)
This commit is contained in:
Jeremy Mayeres 2025-02-25 17:24:21 +02:00 committed by GitHub
parent b498c74bf4
commit 754a7d4c2d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -156,6 +156,7 @@ are automatically verified by this action. The sha256 hashes can be found on the
If you enable caching, the [uv cache](https://docs.astral.sh/uv/concepts/cache/) will be uploaded to If you enable caching, the [uv cache](https://docs.astral.sh/uv/concepts/cache/) will be uploaded to
the GitHub Actions cache. This can speed up runs that reuse the cache by several minutes. the GitHub Actions cache. This can speed up runs that reuse the cache by several minutes.
Caching is enabled by default on GitHub-hosted runners.
> [!TIP] > [!TIP]
> >