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

doc: Better instructions for single-dependency upgrade/downgrade (#27516)

Browse Source 
This change embraces persistent min-version dependencies, which can
simply be ratcheted up over time, or safely removed in time because IDAs
rarely have a large dependency downgrade.

Some dependencies are already encoded with a min-version constraint, which
makes the previous instructions confusing. There was also a very minor
issue in which the temporary constraint line was adding a spurious
`-c constraints.txt` to the committed changes, even though the constraint
itself was not being committed.

This change inspired by discussion on PR #27506.
This commit is contained in:
Tim McCormack
2021-05-04 18:26:18 +00:00
committed by GitHub
parent 599d21b7bb
commit 06422fe8b2
1 changed files with 13 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
requirements/README.rst
View File

@@ -12,15 +12,21 @@ 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
-----------------------------
Upgrading/downgrading just one dependency
-----------------------------------------
Want to upgrade/downgrade just *one* dependency without pulling in other upgrades? Here's how:
Want to upgrade 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)
1. Change your dependency to a minimum-version constraint, e.g. ``my-dep>=1.2.3`` (or update the constraint if it already exists)
2. Run ``make compile-requirements`` to recompute dependencies with this new constraint
3. Remove your constraint
The resulting changes can then be committed.
If you instead need to surgically *downgrade* a dependency, perhaps in order to revert a change which broke things:
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.
1. Add an exact-match or max-version constraint to ``constraints.txt`` with a comment explaining why (and ideally a ticket or issue link)
2. Lower the minimum-version constraint, if it exists
- Not sure if there is one? Try going on to the next step and seeing if it complains!
3. Run ``make compile-requirements``
This is considerably safer than trying to manually edit the ``*.txt`` files, which can easily result in incompatible dependency versions.