docs: clarify tag param description in local cache docs#25169
Open
Se3do wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
github-actions
Bot
added
the
area/build
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the local cache backend documentation to include support for naming cache references via a tag parameter, and clarifies cache versioning behavior.
Changes:
- Reformats the CSV-parameter table and adds a new
tagparameter forcache-to/cache-from. - Removes an outdated “FIXME” comment referencing an old BuildKit PR.
- Adds explanatory text and examples showing how
tagaffects the local OCI layoutindex.json.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+27
to
+39
| | Name | Option | Type | Default | Description | | ||
| | ------------------- | ----------------------- | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `src` | `cache-from` | String | | Path of the local directory where cache gets imported from. | | ||
| | `digest` | `cache-from` | String | | Digest of manifest to import, see [cache versioning][4]. | | ||
| | `tag` | `cache-to`, `cache-from` | String | `latest` | Custom tag for the cache image in the local index, see [cache versioning][4]. | | ||
| | `dest` | `cache-to` | String | | Path of the local directory where cache gets exported to. | | ||
| | `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][1]. | | ||
| | `oci-mediatypes` | `cache-to` | `true`,`false` | `true` | Use OCI media types in exported manifests, see [OCI media types][2]. | | ||
| | `image-manifest` | `cache-to` | `true`,`false` | `true` | When using OCI media types, generate an image manifest instead of an image index for the cache image, see [OCI media types][2]. | | ||
| | `compression` | `cache-to` | `gzip`,`estargz`,`zstd` | `gzip` | Compression type, see [cache compression][3]. | | ||
| | `compression-level` | `cache-to` | `0..22` | | Compression level, see [cache compression][3]. | | ||
| | `force-compression` | `cache-to` | `true`,`false` | `false` | Forcibly apply compression, see [cache compression][3]. | | ||
| | `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. | |
| tag. This lets you store multiple cache outputs in the same directory by | ||
| using different cache reference names; reusing the same `tag` will update that | ||
| reference in `index.json`. | ||
|
|
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
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.
Description
moby/buildkit#3111added support for thetagparameter for the localcache backend in 2022. This PR removes the stale FIXME comment referencing
that change and documents the parameter in the local cache backend docs.
The
tagparameter allows users to assign custom reference names to cacheentries in
index.json. This is useful for storing multiple cache outputsin the same directory without overwriting existing entries.
This PR:
moby/buildkit#3111(merged in Sep 2022 and released years ago)
tagparameter to the CSV parameters table for bothcache-toandcache-fromtagusage in the cache versioning section with exportand import examples
Related issues or tickets
moby/buildkit#3111— addedtagparameter for local cache exporterReviews