Skip to content

Commit bdf6d25

Browse files
X-Guardianbarbados-clemensSimon Heather
authored
docs(core): add cacheKeyPrefix option to s3 remote cache options (#34157)
This pull request updates the documentation for the S3 cache plugin to add the missing `cacheKeyPrefix` setting. Text taken from #31395 Fixes #34147 --------- Co-authored-by: Caleb Ukle <caleb@nrwl.io> Co-authored-by: Caleb Ukle <caleb.ukle+github@pm.me> Co-authored-by: Simon Heather <simon.heather@yulife.com>
1 parent 678cd32 commit bdf6d25

File tree

1 file changed

+14
-0
lines changed
  • astro-docs/src/content/docs/reference/Remote Cache Plugins/s3-cache

1 file changed

+14
-0
lines changed

astro-docs/src/content/docs/reference/Remote Cache Plugins/s3-cache/overview.mdoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@ If you are using MinIO earlier than `2024-07-04T14-25-45Z` it is recommended to
208208
| **accessKeyId** | AWS Access Key ID (optional if `AWS_ACCESS_KEY_ID` is set in the environment) |
209209
| **secretAccessKey** | AWS secret access key (optional if `AWS_SECRET_ACCESS_KEY` is set in the environment) |
210210
| **disableChecksum** | This disables AWS' checksum validation for cache entries |
211+
| **cacheKeyPrefix** | Prefix added to cache keys |
211212

212213
By default, Nx will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
213214

@@ -237,6 +238,19 @@ The cache mode in CI can also be configured by setting `ciMode` to `read-only` o
237238
}
238239
```
239240

241+
# Cache Key Prefix
242+
243+
The `cacheKeyPrefix` setting enables you to add a prefix to your cache keys, making it possible to store multiple projects or environments within the same storage bucket.
244+
245+
```jsonc
246+
// nx.json
247+
{
248+
"s3": {
249+
"cacheKeyPrefix": "designSystem",
250+
},
251+
}
252+
```
253+
240254
### Migrating from Custom Tasks Runners
241255

242256
Many people who are interested in Nx caching plugins have previously used custom task runners. Nx offers a new and simpler extension API designed to meet the same use cases as the now-deprecated custom task runners.

0 commit comments

Comments
 (0)