Skip to content

Commit f7907ee

Browse files
committed
docs: add some make upgrade instructions to the Makefile
1 parent 18b57e1 commit f7907ee

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

Makefile

+9
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,15 @@ metasmoke:
7272

7373
##@ Requirements management
7474

75+
# When updating requirements, a few rules to follow:
76+
#
77+
# 1) Don't install more than one .pip file at once. Always use pip-compile to
78+
# combine .in files onto a single .pip file that can be installed where needed.
79+
#
80+
# 2) Check manual pins before `make upgrade` to see if they can be removed. Look
81+
# in requirements/pins.pip, and search for "windows" in .in files to find pins
82+
# and extra requirements that have been needed, but might be obsolete.
83+
7584
.PHONY: upgrade
7685

7786
PIP_COMPILE = pip-compile --upgrade --allow-unsafe --generate-hashes

0 commit comments

Comments
 (0)