From f7907ee21f9cff21b95f3e107907737ae3078940 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Mon, 15 Aug 2022 10:13:51 -0400 Subject: docs: add some `make upgrade` instructions to the Makefile --- Makefile | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Makefile b/Makefile index c59fe0ec..7778a144 100644 --- a/Makefile +++ b/Makefile @@ -72,6 +72,15 @@ metasmoke: ##@ Requirements management +# When updating requirements, a few rules to follow: +# +# 1) Don't install more than one .pip file at once. Always use pip-compile to +# combine .in files onto a single .pip file that can be installed where needed. +# +# 2) Check manual pins before `make upgrade` to see if they can be removed. Look +# in requirements/pins.pip, and search for "windows" in .in files to find pins +# and extra requirements that have been needed, but might be obsolete. + .PHONY: upgrade PIP_COMPILE = pip-compile --upgrade --allow-unsafe --generate-hashes -- cgit v1.2.1