From: Kyle Mestery Date: Thu, 27 Aug 2015 14:01:57 +0000 (+0000) Subject: devref: Add sub-project release notes X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=c4989982016ac8bd6fb319011ace1d3530a8d78d;p=openstack-build%2Fneutron-build.git devref: Add sub-project release notes Add some notes on the release process we'll utilize for sub-projects under the Neutron stadium. Change-Id: Ib7bce1e3ced959bc7931bd2ecbfe8effba5ed9c0 Signed-off-by: Kyle Mestery --- diff --git a/doc/source/devref/sub_project_guidelines.rst b/doc/source/devref/sub_project_guidelines.rst index 1eecda9ad..3c997f1ee 100644 --- a/doc/source/devref/sub_project_guidelines.rst +++ b/doc/source/devref/sub_project_guidelines.rst @@ -117,11 +117,9 @@ More info on stable branch process can be found on `the following page Releases -------- -It is suggested that you release new subproject tarballs on PyPI from time to -time, especially for stable branches. It will make life of packagers and other -consumers of your code easier. - -Make sure you tag you release commits in git. +It is suggested that sub-projects release new tarballs on PyPI from time to +time, especially for stable branches. It will make the life of packagers and +other consumers of your code easier. It is highly suggested that you do not strip pieces of the source tree (tests, executables, tools) before releasing on PyPI: those missing pieces may be @@ -129,4 +127,22 @@ needed to validate the package, or make the packaging easier or more complete. As a rule of thumb, don't strip anything from the source tree unless completely needed. -TODO: fill in details on release process. +Sub-Project Release Process +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To release a sub-project, follow the following steps: + +* Only members of the `neutron-release + `_ gerrit group can + do releases. Make sure you talk to a member of neutron-release to perform + your release. +* For projects which have not moved to post-versioning, we need to push an + alpha tag to avoid pbr complaining. The neutron-release group will handle + this. +* Modify setup.cfg to remove the version (if you have one), which moves your + project to post-versioning, similar to all the other Neutron projects. You + can skip this step if you don't have a version in setup.cfg. +* Have neutron-release push the tag to gerrit. +* Have neutron-release `tag the release + `_, + which will release the code to PyPi.