Add FAQ section on caching cibuildwheel's downloaded tools#2842
Open
xronocode wants to merge 1 commit into
Open
Add FAQ section on caching cibuildwheel's downloaded tools#2842xronocode wants to merge 1 commit into
xronocode wants to merge 1 commit into
Conversation
Adds a Tips entry covering: - What cibuildwheel caches (CPython/PyPy installers, virtualenv, python-build-standalone archives) and the default per-OS cache folder. - How to override the cache location with ``CIBW_CACHE_PATH``. - A worked GitHub Actions example pairing ``actions/cache`` with ``CIBW_CACHE_PATH`` so the cache survives between runs. - A pointer to ``--clean-cache`` for invalidating stale entries. Closes pypa#1585. Per @joerick's request in the issue ("a caching section in the FAQ would be great, if you can contribute it") the scope is intentionally narrow — just FAQ-level guidance. Platform-specific caching (e.g. Windows NuGet, addressed in pypa#2839) lives in the platforms doc.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1585.
Summary
Adds a Tips entry to
docs/faq.md(placed right before the existing Automatic updates using Dependabot section) covering:CIBW_CACHE_PATH.actions/cachewithCIBW_CACHE_PATHso the cache survives between runs (with arestore-keysfallback so non-pyproject changes still hit a cache).cibuildwheel --clean-cachefor invalidating stale entries.Scope
Per @joerick's reply on the issue ("A caching section in the FAQ would be great, if you can contribute it"), the scope is intentionally narrow — FAQ-level guidance only. The other two items in the original issue body — sharing artifacts between jobs and dispatching workflows across CI providers — are out of scope here:
examples/github-deploy.yml, and per @joerick's comment, "I wouldn't want to go much further than this."ci-services.mdrather than the FAQ.Overlap with #2839
PR #2839 (Windows NuGet caching, closes #1527) edits
docs/platforms.mdwith platform-specific guidance. This PR sits one level higher — FAQ overview pointing readers at the platforms doc for the per-OS specifics. No file overlap.Test plan
uv run --group docs mkdocs build --strict— passesuv run --with prek prek run --files docs/faq.md— passes (eof, line-endings, trailing whitespace, capitalization, codespell)