Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion build/cache/backends/azblob.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,12 @@ The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`.

| Name | Option | Type | Default | Description |
|---------------------|-------------------------|-------------|---------|----------------------------------------------------|
| ------------------- | ----------------------- | ----------- | ------- | -------------------------------------------------- |
| `name` | `cache-to`,`cache-from` | String | | Required. The name of the cache image. |
| `account_url` | `cache-to`,`cache-from` | String | | Base URL of the storage account. |
| `secret_access_key` | `cache-to`,`cache-from` | String | | Blob storage account key, see [authentication][1]. |
| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. |
| `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. |

[1]: #authentication
[2]: index.md#cache-mode
Expand Down
13 changes: 7 additions & 6 deletions build/cache/backends/gha.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,13 @@ $ docker buildx build --push -t <registry>/<image> \
The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`.

| Name | Option | Type | Default | Description |
|---------|-------------------------|-------------|---------------------------------|----------------------------------------------|
| `url` | `cache-to`,`cache-from` | String | `$ACTIONS_CACHE_URL` | Cache server URL, see [authentication][1]. |
| `token` | `cache-to`,`cache-from` | String | `$ACTIONS_RUNTIME_TOKEN` | Access token, see [authentication][1]. |
| `scope` | `cache-to`,`cache-from` | String | Name of the current Git branch. | Cache scope, see [scope][2] |
| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][3]. |
| Name | Option | Type | Default | Description |
| -------------- | ----------------------- | ----------- | ------------------------------- | --------------------------------------------- |
| `url` | `cache-to`,`cache-from` | String | `$ACTIONS_CACHE_URL` | Cache server URL, see [authentication][1]. |
| `token` | `cache-to`,`cache-from` | String | `$ACTIONS_RUNTIME_TOKEN` | Access token, see [authentication][1]. |
| `scope` | `cache-to`,`cache-from` | String | Name of the current Git branch. | Cache scope, see [scope][2] |
| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][3]. |
| `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. |

[1]: #authentication
[2]: #scope
Expand Down
3 changes: 2 additions & 1 deletion build/cache/backends/local.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`.

| 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]. |
| `dest` | `cache-to` | String | | Path of the local directory where cache gets exported to. |
Expand All @@ -44,6 +44,7 @@ The following table describes the available CSV parameters that you can pass to
| `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. |

[1]: index.md#cache-mode
[2]: index.md#oci-media-types
Expand Down
3 changes: 2 additions & 1 deletion build/cache/backends/registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,15 @@ The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`.

| Name | Option | Type | Default | Description |
|---------------------|-------------------------|-------------------------|---------|----------------------------------------------------------------------|
| ------------------- | ----------------------- | ----------------------- | ------- | -------------------------------------------------------------------- |
| `ref` | `cache-to`,`cache-from` | String | | Full name of the cache image to import. |
| `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]. |
| `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. |

[1]: index.md#cache-mode
[2]: index.md#oci-media-types
Expand Down
19 changes: 10 additions & 9 deletions build/cache/backends/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,16 @@ $ docker buildx build --push -t <user>/<image> \
The following table describes the available CSV parameters that you can pass to
`--cache-to` and `--cache-from`.

| Name | Option | Type | Default | Description |
|---------------------|-------------------------|-------------|---------|----------------------------------------------|
| `region` | `cache-to`,`cache-from` | String | | Geographic location. |
| `bucket` | `cache-to`,`cache-from` | String | | Name of the S3 bucket used for caching |
| `name` | `cache-to`,`cache-from` | String | | Name of the cache image |
| `access_key_id` | `cache-to`,`cache-from` | String | | See [authentication][1] |
| `secret_access_key` | `cache-to`,`cache-from` | String | | See [authentication][1] |
| `session_token` | `cache-to`,`cache-from` | String | | See [authentication][1] |
| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. |
| Name | Option | Type | Default | Description |
| ------------------- | ----------------------- | ----------- | ------- | --------------------------------------------- |
| `region` | `cache-to`,`cache-from` | String | | Geographic location. |
| `bucket` | `cache-to`,`cache-from` | String | | Name of the S3 bucket used for caching |
| `name` | `cache-to`,`cache-from` | String | | Name of the cache image |
| `access_key_id` | `cache-to`,`cache-from` | String | | See [authentication][1] |
| `secret_access_key` | `cache-to`,`cache-from` | String | | See [authentication][1] |
| `session_token` | `cache-to`,`cache-from` | String | | See [authentication][1] |
| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. |
| `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. |

[1]: #authentication
[2]: index.md#cache-mode
Expand Down