Create ADR for integrating cache functionality to setup-python action #247
Conversation
| - pipenv - enable caching for pipenv dependencies | ||
| - '' - disable caching (default value) | ||
| - Cache feature will be disabled by default to make sure that we don't break existing customers. | ||
| - Action will try to search dependencies files (requirements.txt for pip and Pipfile.lock for pipenv) in the repository root (or relative to the repository root, if patterns are used) and throw error if no one is found. |
There was a problem hiding this comment.
The most popular file to manage required packages for pip is requirements.txt, so we've decided to use it as default one to calculate hash for the cache key. The main problem with this file is that the requirements file format allows to specify dependency versions using logical operators (for example chardet>=3.0.4) or specify dependencies without any versions. In this case the pip install -r requirements.txt command will always try to install the latest available package version. It can lead to an increase in total build time, since restored cache will not be used if the requirements.txt file is not updated and a newer version of the dependency is available.
Unfortunately, there is no widely used lock file for the pip package manager, so we've decided to use requirements.txt file. We will add a note in the docs about possible issue and provide the cache-dependency-path input so that customer can select a different dependencies file.
Any thoughts and feedback are appreciated
There was a problem hiding this comment.
Overall I agree with this approach 👍 I've mostly seen requirements.txt being used so I think it makes perfect sense to start off with supporting this.
| - pipenv - enable caching for pipenv dependencies | ||
| - '' - disable caching (default value) | ||
| - Cache feature will be disabled by default to make sure that we don't break existing customers. | ||
| - Action will try to search dependencies files (requirements.txt for pip and Pipfile.lock for pipenv) in the repository root (or relative to the repository root, if patterns are used) and throw error if no one is found. |
There was a problem hiding this comment.
Overall I agree with this approach 👍 I've mostly seen requirements.txt being used so I think it makes perfect sense to start off with supporting this.
Prepare an ADR for support caching in setup-python.