Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Describe how to upgrade a single dependency (#27471)

Browse Source
This commit is contained in:
Tim McCormack
2021-04-29 13:45:08 +00:00
committed by GitHub
parent 3c0cfd87a3
commit c8b87560c7
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
requirements/README.rst
View File

@@ -1,3 +1,6 @@
Requirements/dependencies
=========================
These directories specify the Python (and system) dependencies for the LMS and Studio.
- ``edx`` contains the normal Python requirements files
@@ -8,3 +11,16 @@ These directories specify the Python (and system) dependencies for the LMS and S
directly in the requirements directory.)
.. _OEP-18: https://github.com/edx/open-edx-proposals/blob/master/oeps/oep-0018-bp-python-dependencies.rst
Upgrading just one dependency
-----------------------------
Want to upgrade/downgrade just *one* dependency without pulling in other upgrades? Here's how:
1. Add ``my-dep==1.2.3`` to ``requirements/constraints.txt`` temporarily (pin the specific version you want to upgrade to)
2. Run ``make compile-requirements`` to recompute dependencies with this new constraint
3. Remove your constraint
The resulting changes can then be committed.
This is particularly useful when you need to downgrade a dependency which brought in a bug but don't want to roll back all dependency changes. It's also considerably safer than trying to manually edit the ``*.txt`` files, which can easily result in incompatible dependency versions.