zulip/requirements
rht 107e6b4c51 requirements: Clean up dev.txt. 2017-09-15 07:58:40 -07:00
..
README.md requirements: Add documentation on regenerating lockfiles. 2017-09-15 07:58:19 -07:00
common.txt requirements: Add documentation on regenerating lockfiles. 2017-09-15 07:58:19 -07:00
dev.txt requirements: Clean up dev.txt. 2017-09-15 07:58:40 -07:00
dev_lock.txt requirements: Clean up dev.txt. 2017-09-15 07:58:40 -07:00
docs.txt requirements: Add documentation on regenerating lockfiles. 2017-09-15 07:58:19 -07:00
mypy.txt requirements: Add documentation on regenerating lockfiles. 2017-09-15 07:58:19 -07:00
pip.txt requirements: Upgrade setuptools to 36.2.7. 2017-08-21 07:52:15 -07:00
prod.txt requirements: Add documentation on regenerating lockfiles. 2017-09-15 07:58:19 -07:00
prod_lock.txt deps: Adjust the header comments in lock files to reflect our tools. 2017-09-15 00:23:20 -07:00

README.md

The dependency graph of the requirements is as follows:

dev         prod
+ +          +
| +->common<-+
v
mypy,docs

Of the files, only dev, prod, and mypy have been used in the install scripts directly. The rest are implicit dependencies.

common and dev are locked.

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. Increase PROVISION_VERSION in version.py.
  3. Run ./tools/provision to install the new deps and test them
  4. Commit your changes.