Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document source of truth for rctx.download* cache key #22716

Closed
wants to merge 5 commits into from
Closed

Document source of truth for rctx.download* cache key #22716

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
67fcf78
Document `canonical_id` defaults for `rctx.download*`
Silic0nS0ldier Jun 12, 2024
23a82cb
Note cache behaviour in `sha256` and `integrity`, rephrase `canonical…
Silic0nS0ldier Jun 12, 2024
f9245f5
Merge remote-tracking branch 'upstream/master' into canonical-id-docs
Silic0nS0ldier Jun 29, 2024
2d899f3
Merge remote-tracking branch 'upstream/master' into canonical-id-docs
Silic0nS0ldier Jul 17, 2024
9f9da95
Match reindenting of those docs
Silic0nS0ldier Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions .../com/google/devtools/build/lib/bazel/repository/starlark/StarlarkBaseExternalContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,10 @@ private StructImpl completeDownload(PendingDownload pendingDownload)
This must match the SHA-256 hash of the file downloaded. It is a security \
risk to omit the SHA-256 as remote files can change. At best omitting this \
field will make your build non-hermetic. It is optional to make development \
easier but should be set before shipping.
easier but should be set before shipping. \
If provided, the repository cache will first be checked for a file with the \
given hash; a download will only be attempted if the file was not found in \
the cache. After a successful download, the file will be added to the cache.
"""),
@Param(
name = "executable",
Expand All @@ -660,7 +663,8 @@ private StructImpl completeDownload(PendingDownload pendingDownload)
doc =
"""
If set, restrict cache hits to those cases where the file was added to the cache \
with the same canonical id.
with the same canonical id. By default caching uses the checksum \
(<code>sha256</code> or <code>integrity</code>).
"""),
@Param(
name = "auth",
Expand All @@ -683,7 +687,10 @@ private StructImpl completeDownload(PendingDownload pendingDownload)
This must match the checksum of the file downloaded. It is a security \
risk to omit the checksum as remote files can change. At best omitting this \
field will make your build non-hermetic. It is optional to make development \
easier but should be set before shipping.
easier but should be set before shipping. \
If provided, the repository cache will first be checked for a file with the \
given checksum; a download will only be attempted if the file was not found in \
the cache. After a successful download, the file will be added to the cache.
"""),
@Param(
name = "block",
Expand Down Expand Up @@ -879,7 +886,8 @@ public Object download(
doc =
"""
If set, restrict cache hits to those cases where the file was added to the cache \
with the same canonical id.
with the same canonical id. By default caching uses the checksum"
(<code>sha256</code> or <code>integrity</code>).
"""),
@Param(
name = "auth",
Expand All @@ -902,7 +910,10 @@ public Object download(
This must match the checksum of the file downloaded. It is a security \
risk to omit the checksum as remote files can change. At best omitting this \
field will make your build non-hermetic. It is optional to make development \
easier but should be set before shipping.
easier but should be set before shipping. \
If provided, the repository cache will first be checked for a file with the \
given checksum; a download will only be attempted if the file was not found in \
the cache. After a successful download, the file will be added to the cache. \
"""),
@Param(
name = "rename_files",
Expand Down
Loading