Add info on needing publish-to-pypi template

The "Tagging a Release" section is easy to find with internet
searches, and in isolation can be misleading without additional
information on needing a publish-to-pypi template associated
with the project wanting to do a release. This adds that
information with some links to additional info.

Change-Id: I2b9eeb327db032e4173628398d9003b5f221ae76
This commit is contained in:
Chris Dent 2018-10-29 19:40:34 +00:00 committed by Andreas Jaeger
parent e29aeb4bbf
commit ade2fb243b
1 changed files with 7 additions and 0 deletions

View File

@ -250,6 +250,13 @@ and push that tag to Gerrit by running the following commands::
.. note::
* Pushing the tag will trigger the release pipeline in zuul, but without
proper configuration no release will happen. A publishing job is required.
One common way to do this is to use a `publish-to-pypi template
<https://docs.openstack.org/infra/openstack-zuul-jobs/project-templates.html#project_template-publish-to-pypi-python3>`_
in `openstack-infra/project-config <https://git.openstack.org/cgit/openstack-infra/project-config/>`_.
The publishing jobs are one of the :ref:`central-config-exceptions`.
* Tags can't be effectively deleted once pushed, so make absolutely
certain they're correct (ideally by locally testing release
artifact generation commands and inspecting the results between