Commit Graph

51 Commits

Author SHA1 Message Date
zhangboye fca5c491fb Add Source links to readme
Change-Id: If45ce922d6c5da3bd62dddbca6d89fd403d93eef
2019-10-17 15:50:57 +08:00
Matthew Thode 01ccedef0e
Rebuild docs: DRY edition
Point to the dependency management docs for general review guidelines and
add docs for the freeze process.

Story: 2003792
Task: 26500
Depends-On: https://review.openstack.org/615388
Change-Id: I5adb28faaeb19735445450c26bcf40ecd5336a9f
2018-11-03 14:32:03 -05:00
Zane Bitter ac1509efd2 Link to Review Guidelines again
When the review guidelines were moved to the project team guide by
3cdb85d35f, the internal link broke.
Provide the correct external link.

Change-Id: I0374c8904f9e807b524e1cc41f0e0ff4924fce79
2018-09-21 11:27:33 -04:00
Doug Hellmann 0ae1c7fd19 add tox env for running requirements-check
Set up a tox environment for running project-requirements-change.py,
the script used in the requirements-check job.

Change-Id: I5336222949acfd947f2ef54ed120e3632b28ccb7
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-07-11 07:34:10 -04:00
Doug Hellmann 8d106be517 remove the global lower-constraints.txt file
Rely on our ability to compute a good lower constraints set for
multiple projects using the build-lower-constraints command instead of
maintaining a single list in this repository.

Change-Id: I0a4be42efdbfd73228d043c1aa21feb7829650f3
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-07-05 09:38:09 -04:00
Doug Hellmann 9fa26daf57 add build-lower-constraints command
Add a command to merge lower constraints lists together, as a
precursor to removing the global lower-constraints.txt list in this
repository.

Change-Id: Ia238607b9feb292842971d0fc161ae6294150e1f
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-07-02 11:29:34 -04:00
Doug Hellmann 3cdb85d35f remove readme content that moved to project-team-guide
This information is in the project-team-guide repository.

Change-Id: Ic72e0ca7bb07ada8698fd4919aa4e3906f4a96f0
Depends-On: https://review.openstack.org/561055
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-04-12 17:41:00 -04:00
Doug Hellmann d7e9c86bd5 clean up readme
Fix the tag badges.

Update the rule about minimum versions.

Remove the section about upgrading dependencies, since that happens in
each repository now.

Change-Id: I9b6ade5e389c72baa92ac35700e9edeafc3d79f3
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-04-12 17:40:50 -04:00
Dirk Mueller 0d5d4e9855 Add documentation for lower-constraints.txt
Change-Id: I049dbaf3893a63aed3519ef5f25bfd3c62bdfdc4
2018-03-04 13:31:45 +01:00
Pierre Riteau f2481af1e6 Remove documentation about USE_CONSTRAINTS
The USE_CONSTRAINTS configuration variable was removed from DevStack
more than two years ago, however the requirements README was still
referencing it.

This patch also fixes the capitalization of DevStack throughout the
file.

Change-Id: I0ee4db73b0b6859c0f8a2c6b4a22befb98bcd928
2017-11-28 15:13:01 +00:00
Andreas Jaeger f4f57e0024 Handle doc/requirements.txt
Change Ief487e1d20ea20facf398367ca03a6385182fb38 updated the PTI for doc
jobs and introduces doc/requirements.txt. Support that for requirements
syncing.

Change-Id: I147a129438ae370eb4c90ee93a634fa61cc179f4
2017-11-23 20:09:01 +01:00
Andreas Jaeger 29e92f930c Switch to openstackdocstheme
Use openstackdocstheme instead of obsolete oslosphinx.

Fix display problem with removing extraneous whitespace in README.rst.

Change-Id: I791e830c6a13476152fb26a95de6832a6c50adae
2017-08-26 14:57:42 +02:00
howardlee 4b01754380 Update and replace http with https for doc links
1) Update doc links according to OpenStack document migration
2) Use https instead of http for docs links

Change-Id: I2d558e68b060ae893bafccf51333d1fd5d061322
2017-07-22 11:14:40 +08:00
Tony Breeds 7479ff9c39 [doc] Add a few clarifying statements for stable branch guidelines
Change-Id: I042c42330735bbff7f8c0faedecb0b8c08060e27
2017-06-30 11:55:41 +10:00
Tony Breeds 80a3d1bb71 Move the Stable rules under review guidlines
Havign the stable rules in the middle of the tools section makes them
hard to find.  Move them to the Review guidelines.

Change-Id: I821cc6c311201cce80a260bc698f60171a2ee2e5
2017-06-29 11:12:53 +10:00
Jenkins 3a215b778c Merge "Add cycle-with-intermediary requirement" 2017-06-02 18:28:19 +00:00
Matthew Thode 33552d66dc
Add cycle-with-intermediary requirement
This is needed for Openstack managed projects to ensure continuing
coinstallability and integration with other requirements managed projects.

Change-Id: I21728d738edc9fb6c4e5264c2929c22083d6d036
2017-05-31 10:09:27 -05:00
Matthew Thode 7cb64a0a15
Add review criteria for stable-branch maintenance
As we've discussed on IRC, document the criteria used to perform reviews on
the stable branches to help facilitate more core reviewers on those stable
branches.

Change-Id: I99d2566614a3cd85428c396faa4a6f58cd5ba9be
2017-05-31 09:15:24 -05:00
Dariusz Smigiel 54db8df04a Added info about u-c update, for new libraries
When new library is added to requirements, also upper-constraints needs
to be updated.

Change-Id: I55253b953f824097c793695eae25b9a064cfa4c6
2017-03-21 14:05:44 +00:00
xuchao 316c00de8e Update home-page url and README.rst file
Change-Id: I065526f414a85e30240598e2c4fc74c3eb07cc14
2016-12-03 13:08:49 -05:00
Flavio Percoco 72f2913e13 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/7fa9461bc9851fdc5242f54e29ac0fb4

Change-Id: I94783fd93f760a7694760019f4a24ff122aeb5a7
2016-11-25 17:15:06 +01:00
Luong Anh Tuan fa4e1f722f Fix a typo in documentation
remove redundant 'are'

Change-Id: Ibe57f1ba7096a5032642f8cf845682e27a0f296b
2016-10-04 09:07:19 +07:00
Ihar Hrachyshka b97f008059 Use python3 to calculate freezes
We need the integration gate to work with both trusty (python3.4) and
xenial (python3.5).  Rather than hard code the full python binary just
use python 3 and let the OS mange this for us. This is less than ideal
but it's the best we can do right now to unblock the gate.

We also address a short term issue with out upper-constraints.txt files
and manually copy the constraints from 3.4 to 3.5

Related-Bug: 1620436
Change-Id: I6acabf86933b7a7bce7baf44e6b512e7d0d2f6db
2016-09-06 03:34:23 +00:00
Swapnil Kulkarni (coolsvap) c5a9cf35c8 Update questionnaire for new requirement
Added question for specifying which project needs
the new library

Change-Id: I360f65d8ca3fb0884d38466aed15588d870a91cd
2016-06-08 20:16:54 +05:30
Jenkins a0e2d54e5c Merge "update the review instructions for new lib releases" 2016-05-18 05:42:47 +00:00
Jenkins 1a27437ada Merge "Clarify wording by mentioning the name of the gate job" 2016-05-16 19:17:01 +00:00
Doug Hellmann d741499926 update the review instructions for new lib releases
We updated the release process to ask folks to submit constraint
updates, and this change updates the review instructions here to tell
new reviewers to allow them.

Change-Id: I5b8a4d3922794b05d34dc8355de97ee7dd2bf42a
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2016-05-16 16:08:38 +00:00
Matthew Thode 18f9f77558
Add Gentoo to distro status
Gentoo packages OpenStack and as such should (optionally) have packages
looked up when adding packages to requirements.

I've added Gentoo as a distro between Debian and SUSE for alphabetical
reasons only and have also added a link to our official package tracker.

Change-Id: Id4bd773510422a793854d46e7dcaa4e69ed36625
2016-05-12 16:08:35 -05:00
Jenkins 52e7ebf21c Merge "Add review guideline about projects.txt updates" 2016-05-12 20:46:57 +00:00
Dirk Mueller d58a36e40f Clarify wording by mentioning the name of the gate job
Also, it seems intintion is that the check-requirements
job is already active, so reword by explaining that the
infra job needs to be first

Change-Id: I6ccf96faeebd2c759e5299165a410d792851f52a
2016-05-11 23:35:50 +02:00
Dirk Mueller 83a6135f69 Add review guideline about projects.txt updates
Mention that projects.txt updates should be approved
quicker than the other updates so that the OpenStack
Proposal Bot does the right thing.

Change-Id: I8ee54e26146df6d907e8cb6349bae986dd5690c1
2016-05-11 17:50:10 +02:00
Dirk Mueller 9a5cdfc35b Add pointer for SUSE python packaging devel project
Change-Id: Iffa4fafc2cb8474ea0790b5ea4c0c37ded0f7b2d
2016-04-30 14:48:41 -05:00
Thierry Carrez 0cb0425d42 Precisions on the licensing requirements
Add some precision on reviewing licensing requirements when adding
new dependencies.

Change-Id: I46bda1f9792c4cb01860dca3c3dbcbb4a0ea9287
2016-03-24 16:38:12 +01:00
James E. Blair 252c0a035d Reference TC doc on licensing
Our licensing stance is slightly more nuanced than was described
here.  Reference the external TC statement on licensing requirements
rather than trying to re-describe it here.

Change-Id: I5ffb95c153967decb89890f5132a2819ad569308
2016-02-14 08:16:50 -08:00
Zhao Lei 3abda1e284 Fix a little spelling typo in README and error message
s/occured/occurred/
s/occuring/occurring/

Change-Id: Iaec8aeb0ec5c2c3638146f525868b65ab943f71f
Signed-off-by: Zhao Lei <zhaolei@cn.fujitsu.com>
2015-12-11 09:26:28 +00:00
Xi Yang 09a4847d0e Remove redundant space in the README.rst
There is a redundant space in the README.rst file,
this patch is going to remove it.

Change-Id: Ice46dac646c83bbc030073cc37744c0db9ce69b4
2015-12-04 21:21:26 +08:00
Robert Collins 7eab32a33b Document the blacklist intent for reviewers.
Change-Id: If99e6997b11e50758a9041cacbc4f4c7938cb11f
2015-10-20 10:52:27 +13:00
Nikolay Mahotkin bd92e79396 Fixing code-blocks in README.rst
* Fixed some code-blocks which were wrong

Change-Id: Ie9c2c241546f2a55bc70164642bcd8aec50077c5
2015-09-22 09:40:16 +03:00
Joshua Hesketh d4388e7573 Fix some mistakes in README.rst
Change-Id: I554b82a73c7352e84741a2c80f70b355ff93c507
2015-09-03 20:29:08 +10:00
Salvatore Orlando d8a9d65118 README.rst: generate-constraints requires -r option
It seems the requirements file must be specified when using the
generate-constraints utility.
This patch amends the README.rst file to reflect this, as it
currently appears to hint that the -r options default to
global-requirements.txt

Change-Id: I1b2d67f717e1050b11d974da69071b127dd864c8
2015-08-14 04:04:14 -07:00
Doug Hellmann 43d00f8093 Update review policy for our libraries
Change-Id: I08ef8a1eee07225fbf1b98319b44f8f9d5c0d614
2015-08-13 19:16:47 +00:00
Robert Collins 23fd686a57 Document current constraints status.
This updates the documentation to where we are today, provides a reference for
some useful tips and tricks, and finally encodes the decision from the list
about +2A the automated constraints updates.

Change-Id: I20cf7cf429068580901de430e50d536a5e6694f6
Depends-On: I29ffd7376c6f77ca104bf7d930fef178e5cab20f
2015-07-29 06:48:27 +12:00
Robert Collins 4273910b78 Add upper-constraints.txt generator.
This script when run creates a constraints file with exact pins for
the transitive dependencies of a requirements file.

Change-Id: I1282f8e4010c0ec46c473495bacddf044d06c0af
2015-06-20 19:19:21 +12:00
Robert Collins 9414f91f87 Document the global requirements format.
Change-Id: I4496209c95908179c4b383e7f0a5b8595173564b
2015-06-17 01:32:23 +12:00
Robert Collins f0fddb47bb Introduce upper-constraints to requirements.
This is thoroughly documented in the cross project spec 'requirements
management'. In short though, we manage the exact versions we test
with as a change controlled thing and use async processes to push
convergence and keep up to date.

Change-Id: I5fc747646ae9371f0cc085b1e15af45951d20152
2015-06-03 23:04:04 +12:00
YAMAMOTO Takashi 77ca6cb798 README.rst: Fix a typo
Change-Id: Ia0cb6ecd1ee7bb6a56e639bb5076b78fbe3e0d64
2015-02-10 18:55:55 +09:00
Andreas Jaeger 0b6b91ce36 Fix nits in README.rst
Fix spelling of SUSE, use "three" instead of "3".

Change-Id: I4c8880a9a245d7a5b13cfc114d974686e927f1f7
2014-09-25 14:31:59 +02:00
Sean Dague 12d999e49c updated requirements repo readme
The purpose of the requirements repository, it's history, and
consistent review guidelines are something that's currently lore
passed down through the ages.

We should write this stuff down, and come up with consistent
guidelines for submitters and reviewers to get us all onto a single
page wrt reviewing and acceptance criteria.

Change-Id: I72f0f5771fee637d0b651d76217ce3959a4b92b7
2014-09-23 14:42:40 -04:00
Davanum Srinivas fe5b795be2 Update README with rationale and internal mirror
Added why folks need to add their projects here and what it
will help with

Change-Id: Ia57e1197de8ad32fb819d1bd211b37b82db63518
2014-02-07 15:36:49 -05:00
Monty Taylor ec9cf61690 Rename pip-requires to requirements.txt.
Change-Id: I4cfdd0ef6cddfa3d75b4d650362f9645486755c8
2013-06-30 10:07:41 -04:00