From dc61549bf2fcc0d2a630023bb3ad03363c7eeec7 Mon Sep 17 00:00:00 2001 From: Seth Woodworth Date: Fri, 18 Oct 2019 12:56:32 -0400 Subject: [PATCH] Update README Caches section Note that useStaticCache and useDownloadCache are both defaulted to true as of ded33985c3a6ea8a53922c17936ff0d04f3bc3d5 --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f583ec46..12586e92 100644 --- a/README.md +++ b/README.md @@ -239,16 +239,15 @@ custom: ## Extra Config Options ### Caching -You can enable two kinds of caching with this plugin which are currently both DISABLED by default. First, a download cache that will cache downloads that pip needs to compile the packages. And second, a what we call "static caching" which caches output of pip after compiling everything for your requirements file. Since generally requirements.txt files rarely change, you will often see large amounts of speed improvements when enabling the static cache feature. These caches will be shared between all your projects if no custom cacheLocation is specified (see below). +You can enable two kinds of caching with this plugin which are currently both ENABLED by default. First, a download cache that will cache downloads that pip needs to compile the packages. And second, a what we call "static caching" which caches output of pip after compiling everything for your requirements file. Since generally requirements.txt files rarely change, you will often see large amounts of speed improvements when enabling the static cache feature. These caches will be shared between all your projects if no custom cacheLocation is specified (see below). _**Please note:** This has replaced the previously recommended usage of "--cache-dir" in the pipCmdExtraArgs_ ```yaml custom: pythonRequirements: - useDownloadCache: true - useStaticCache: true + useDownloadCache: false + useStaticCache: false ``` -_Additionally, In future versions of this plugin, both caching features will probably be enabled by default_ ### Other caching options... There are two additional options related to caching. You can specify where in your system that this plugin caches with the `cacheLocation` option. By default it will figure out automatically where based on your username and your OS to store the cache via the [appdirectory](https://www.npmjs.com/package/appdirectory) module. Additionally, you can specify how many max static caches to store with `staticCacheMaxVersions`, as a simple attempt to limit disk space usage for caching. This is DISABLED (set to 0) by default. Example: