docs: document how requirements.txt is updated

we should update this document once jazzband/pip-tools#625 is fixed and/or jazzband/pip-tools#908 is merged Signed-off-by: Kefu Chai <kchai@redhat.com>
kshtsk · Dec 11, 2019 · c02e76a · c02e76a
1 parent 2c035f1
commit c02e76a
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst
@@ -60,3 +60,13 @@ Or from GitHub::
 
 where the dependencies for orchestrating are installed. They are used for
 interacting with the services to schedule tests and to report the test results.
+
+
+Update Dependencies
+-------------------
+
+We track the dependencies using ``requirements.txt``. These packages are tested,
+and should work with teuthology. But if you want to bump up the versions of them,
+please use the following command to update this file ::
+
+  pip-compile -qo- | sed '/^-e / d' > requirements.txt
diff --git a/requirements.in b/requirements.in
@@ -0,0 +1 @@
+-e .[coverage,orchestra,test]