Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

requirements: Add documentation on regenerating lockfiles.

This commit is contained in:
rht 2017-08-30 00:45:33 +02:00 committed by Tim Abbott
parent b334f3a9a4
commit 2d06004ee9
6 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
requirements/README.md
View File

@ -17,9 +17,6 @@ Steps to update a lock file, e.g. to update ipython from 5.3.0 to 6.0.0 in
common.txt and propagate it to dev_lock.txt and prod_lock.txt:
0. Replace `ipython==5.4.1` with `ipython==6.0.0` in common.txt
1. Run './tools/update-locked-requirements'
2. Run `./tools/provision` to install the new deps and test them
3. Commit your changes.
The reason the steps to remove the `-e` is necessary is because `pip-compile`
doesn't support installing from vcs without `-e` yet.
You may track the ongoing progress here https://github.com/jazzband/pip-tools/issues/355.
2. Increase `PROVISION_VERSION` in `version.py`.
3. Run `./tools/provision` to install the new deps and test them
4. Commit your changes.

4
requirements/common.txt
View File

@ -1,3 +1,7 @@
# After editing this file, you MUST afterward run
# /tools/update-locked-requirements to update requirements/dev_lock.txt
# and requirements/prod_lock.txt.
# See requirements/README.md for more detail.
# Django itself; we use a slightly patched version
Django==1.11.4

3
requirements/dev.txt
View File

@ -1,3 +1,6 @@
# After editing this file, you MUST afterward run
# /tools/update-locked-requirements to update requirements/dev_lock.txt.
# See requirements/README.md for more detail.
-r common.txt
-r docs.txt

4
requirements/docs.txt
View File

@ -2,6 +2,10 @@
# valuable to keep this file as just the dependencies for our
# documentation.
# After editing this file, you MUST afterward run
# /tools/update-locked-requirements to update requirements/dev_lock.txt.
# See requirements/README.md for more detail.
# Needed to build RTD docs
sphinx==1.6.2
sphinx-rtd-theme==0.2.4

3
requirements/mypy.txt
View File

@ -1,3 +1,6 @@
# After editing this file, you MUST afterward run
# /tools/update-locked-requirements to update requirements/dev_lock.txt.
# See requirements/README.md for more detail.
six==1.10.0
-e git+https://github.com/python/mypy.git@d96b2cf22216a4ad6aa55a5726ee35a3fa38c637#egg=mypy==0.530-dev
typed-ast==1.1.0

3
requirements/prod.txt
View File

@ -1,3 +1,6 @@
# After editing this file, you MUST afterward run
# /tools/update-locked-requirements to update requirements/prod_lock.txt.
# See requirements/README.md for more detail.
-r common.txt
# Used for running the Zulip production Django server
uWSGI==2.0.14