From 028c477c2242e7c322b68c4730ed1868008c37d8 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 17 Feb 2015 12:56:19 +0000 Subject: [PATCH] Note on using pip-review in docs. --- docs/topics/project-management.md | 10 ++++++++++ requirements/requirements-packaging.txt | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/topics/project-management.md b/docs/topics/project-management.md index 2a54fb94e..dfe0d6357 100644 --- a/docs/topics/project-management.md +++ b/docs/topics/project-management.md @@ -166,6 +166,16 @@ When a translator has finished translating their work needs to be downloaded fro --- +## Project requirements + +All our test requirements are pinned to exact versions, in order to ensure that our test runs are reproducible. We maintain the requirements in the `requirements` directory. The requirements files are referenced from the `tox.ini` configuration file, ensuring we have a single source of truth for package versions used in testing. + +You can check if there are any packages available at a newer version, by using the `pip-review` tool. + +Package upgrades should generally be treated as isolated pull requests. Also note that the `pip-dump` command does not work gracefully with our requirements layout style, so any edits should be made manually. + +--- + ## Project ownership The PyPI package is owned by `@tomchristie`. As a backup `@j4mie` also has ownership of the package. diff --git a/requirements/requirements-packaging.txt b/requirements/requirements-packaging.txt index e4ac77403..7782d63a7 100644 --- a/requirements/requirements-packaging.txt +++ b/requirements/requirements-packaging.txt @@ -7,5 +7,5 @@ twine==1.4.0 # Transifex client for managing translation resources. transifex-client==0.10 -# The pip-review and pip-dump tools for package upgrades. +# The pip-review tool for checking package upgrades. pip-tools==0.3.5