openstack
/
project-team-guide
Code Issues Proposed changes

Update dependency-management doc 

This makes two changes:

1. Clarifies that version specifiers in global-requirements.txt
   should only be for excluding known bad versions, not for setting
   minimum required versions of dependencies.

2. The tox section is removed since upper-constraints has been used
   in tox (unit test, pep8, etc) jobs for several releases now.

Alternative to #2, we could leave the tox section in place but update
it to indicate that except for the new(ish) lower-constraints jobs,
all tox jobs should be using branch-specific upper-constraints.

Change-Id: Ieef749c1486c120e491c62344b6f0e1e03570267
This commit is contained in:
Matt Riedemann 2018-05-16 11:33:23 -04:00
parent 34eda618ab
commit 4d547ed086
1 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/source/dependency-management.rst
View File

@ -74,10 +74,13 @@ Format
``global-requirements.txt`` supports a subset of pip requirement file
contents. Distributions may only be referenced by name, not URL. Options
(such as -e or -f) may not be used. Version specifiers, environment markers
and comments are all permitted. A single distribution may be listed more than
once if different specifiers are required with different markers - for
instance, if a dependency has dropped Python 2.7 support.
(such as -e or -f) may not be used. Environment markers
and comments are permitted. Version specifiers are only allowed for excluding
(blacklisting) versions, not setting minimum required versions. Minimum
required versions should be specified in ``lower-constraints.txt`` per-project.
A single distribution may be listed more than once if different specifiers are
required with different markers - for instance, if a dependency has dropped
Python 2.7 support.
``upper-constraints.txt`` is machine generated and nothing more or less than
an exact list of versions.
@ -93,12 +96,6 @@ DevStack uses the pip ``-c`` option to pin all the libraries to known good
versions. ``edit-constraints`` can be used to unpin a single constraint, and
this is done to install libraries from git.
Tox
+++
We are working on the necessary changes to use ``upper-constraints.txt`` in
tox jobs but it is not yet complete.
Enforcement in Projects
-----------------------