Open Stack

On 2013-12-17 22:21:14 +0100 (+0100), Andreas Jaeger wrote:
[...]
> I've made an initial python package now out of openstack-doc-tools.

Looking at the repo, at a minimum there's still a few things you'll
need to pick up from...

<URL: http://git.openstack.org/cgit/openstack-dev/cookiecutter/tree/%7b%7bcookiecutter.repo_name%7d%7d >

But at a minimum you'll need a tox.ini with a [testenv:venv] section
so that the tarball job will be able to run its builder...

<URL: http://git.openstack.org/cgit/openstack-infra/config/tree/modules/openstack_project/files/jenkins_job_builder/config/macros.yaml#n174 >

Ultimately, though, you should have a browse through the
cookiecutter repo and see whether there's anything else in there
which could be relevant to your project since it will be more
consistent with OpenStack python packaging consensus that way.

> I've briefly discussed with Fungi on IRC on the next steps. He
> mentioned that we need to get openstack-doc-tools uploading to
> pypi - and a way to release a new package version with signed
> tags. Fungi, will you do the pypi setup and explain what needs to
> be done with the signed tags by the documentation team, please?

I've registered a placeholder on PyPI which we'll be able to update
from Jenkins jobs...

<URL: https://pypi.python.org/pypi/openstack-doc-tools >

You'll still need tarball and pypi-upload release jobs for your
project in zuul's configuration...

<URL: http://git.openstack.org/cgit/openstack-infra/config/tree/modules/openstack_project/files/zuul/layout.yaml >

...and an entry in the JJB project configuration adding the
python-jobs group for your project (to instantiate the templates for
the jobs mentioned above)...

<URL: http://git.openstack.org/cgit/openstack-infra/config/tree/modules/openstack_project/files/jenkins_job_builder/config/projects.yaml >

Being able to trigger the release process itself depends on a tag
ACL in Gerrit, which you'll want added to...

<URL: http://git.openstack.org/cgit/openstack-infra/config/tree/modules/openstack_project/files/gerrit/acls/openstack/openstack-doc-tools.config >

(Look in any of the python-*client.config files in that same
directory for a sample [access "refs/tags/*"] section.) You'll
probably want a smaller group than openstack-doc-core acting as a
release manager for this project, so maybe we need to discuss using
a openstack-doc-tools-ptl group to contain the PTL and release
delegates for it. The release process they'll follow is outlined
at...

<URL: https://wiki.openstack.org/wiki/GerritJenkinsGithub#Tagging_a_Release >

> What do I then need to change in openstack-manuals to have it
> automatically use the latest version of the package?

If your jobs are run using tox, just sticking a line in
requirements.txt or test-requirements.txt of the project in question
which says "openstack-doc-tools" should be enough, but I'd need to
know a little more about which jobs you mean before I could say for
sure.
-- 
Jeremy Stanley