|
| 1 | +/** |
| 2 | + * This configuration file manages Rush's build cache feature. |
| 3 | + * More documentation is available on the Rush website: https://rushjs.io |
| 4 | + */ |
| 5 | +{ |
| 6 | + "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/build-cache.schema.json", |
| 7 | + |
| 8 | + /** |
| 9 | + * (Required) EXPERIMENTAL - Set this to true to enable the build cache feature. |
| 10 | + * |
| 11 | + * See https://rushjs.io/pages/maintainer/build_cache/ for details about this experimental feature. |
| 12 | + */ |
| 13 | + "buildCacheEnabled": true, |
| 14 | + |
| 15 | + /** |
| 16 | + * (Required) Choose where project build outputs will be cached. |
| 17 | + * |
| 18 | + * Possible values: "local-only", "azure-blob-storage", "amazon-s3" |
| 19 | + */ |
| 20 | + "cacheProvider": "local-only", |
| 21 | + |
| 22 | + /** |
| 23 | + * Setting this property overrides the cache entry ID. If this property is set, it must contain |
| 24 | + * a [hash] token. |
| 25 | + * |
| 26 | + * Other available tokens: |
| 27 | + * - [projectName] |
| 28 | + * - [projectName:normalize] |
| 29 | + * - [phaseName] |
| 30 | + * - [phaseName:normalize] |
| 31 | + * - [phaseName:trimPrefix] |
| 32 | + */ |
| 33 | + // "cacheEntryNamePattern": "[projectName:normalize]-[phaseName:normalize]-[hash]" |
| 34 | + |
| 35 | + /** |
| 36 | + * Use this configuration with "cacheProvider"="azure-blob-storage" |
| 37 | + */ |
| 38 | + "azureBlobStorageConfiguration": { |
| 39 | + /** |
| 40 | + * (Required) The name of the the Azure storage account to use for build cache. |
| 41 | + */ |
| 42 | + // "storageAccountName": "example", |
| 43 | + /** |
| 44 | + * (Required) The name of the container in the Azure storage account to use for build cache. |
| 45 | + */ |
| 46 | + // "storageContainerName": "my-container", |
| 47 | + /** |
| 48 | + * The Azure environment the storage account exists in. Defaults to AzurePublicCloud. |
| 49 | + * |
| 50 | + * Possible values: "AzurePublicCloud", "AzureChina", "AzureGermany", "AzureGovernment" |
| 51 | + */ |
| 52 | + // "azureEnvironment": "AzurePublicCloud", |
| 53 | + /** |
| 54 | + * An optional prefix for cache item blob names. |
| 55 | + */ |
| 56 | + // "blobPrefix": "my-prefix", |
| 57 | + /** |
| 58 | + * If set to true, allow writing to the cache. Defaults to false. |
| 59 | + */ |
| 60 | + // "isCacheWriteAllowed": true |
| 61 | + }, |
| 62 | + |
| 63 | + /** |
| 64 | + * Use this configuration with "cacheProvider"="amazon-s3" |
| 65 | + */ |
| 66 | + "amazonS3Configuration": { |
| 67 | + /** |
| 68 | + * (Required unless s3Endpoint is specified) The name of the bucket to use for build cache. |
| 69 | + * Example: "my-bucket" |
| 70 | + */ |
| 71 | + // "s3Bucket": "my-bucket", |
| 72 | + /** |
| 73 | + * (Required unless s3Bucket is specified) The Amazon S3 endpoint of the bucket to use for build cache. |
| 74 | + * This should not include any path; use the s3Prefix to set the path. |
| 75 | + * Examples: "my-bucket.s3.us-east-2.amazonaws.com" or "http://localhost:9000" |
| 76 | + */ |
| 77 | + // "s3Endpoint": "https://my-bucket.s3.us-east-2.amazonaws.com", |
| 78 | + /** |
| 79 | + * (Required) The Amazon S3 region of the bucket to use for build cache. |
| 80 | + * Example: "us-east-1" |
| 81 | + */ |
| 82 | + // "s3Region": "us-east-1", |
| 83 | + /** |
| 84 | + * An optional prefix ("folder") for cache items. It should not start with "/". |
| 85 | + */ |
| 86 | + // "s3Prefix": "my-prefix", |
| 87 | + /** |
| 88 | + * If set to true, allow writing to the cache. Defaults to false. |
| 89 | + */ |
| 90 | + // "isCacheWriteAllowed": true |
| 91 | + } |
| 92 | +} |
0 commit comments