From 607b2db8c748b99523c22233061afd39df3b2d5b Mon Sep 17 00:00:00 2001 From: Clark Boylan Date: Wed, 26 Sep 2012 13:39:31 -0700 Subject: [PATCH] Use Jenkins Job Builder to config ci-docs job. The existing ci-docs job is a one off job that was configured by hand. Define the ci-docs job as a Jenkins Job Builder job using the existing project-docs utilities. To make the existing utilities work within the puppet repo the doc files have been moved to doc/source, setup.cfg added to build docs in the new dir, setup.py builds openstack-ci-puppet (instead of nova), tox now has a venv virtualenv, and the .gitignore has been updated appropriately. Change-Id: Ic0f291af181b4ef8eff62c5ec7cf3ccfa5b79800 Reviewed-on: https://review.openstack.org/13729 Approved: James E. Blair Reviewed-by: James E. Blair Tested-by: Jenkins --- .gitignore | 5 +++-- doc/{ => source}/conf.py | 0 doc/{ => source}/gerrit.rst | 0 doc/{ => source}/index.rst | 0 doc/{ => source}/jenkins.rst | 0 doc/{ => source}/jenkins_jobs.rst | 0 doc/{ => source}/meetbot.rst | 0 doc/{ => source}/puppet.rst | 0 doc/{ => source}/puppet_modules.rst | 0 doc/{ => source}/systems.rst | 0 doc/{ => source}/third_party.rst | 0 .../config/openstack-ci-puppet.yaml | 22 +++++++++++++++++++ .../openstack_project/files/zuul/layout.yaml | 2 ++ setup.cfg | 4 ++++ setup.py | 2 +- tox.ini | 4 ++++ 16 files changed, 36 insertions(+), 3 deletions(-) rename doc/{ => source}/conf.py (100%) rename doc/{ => source}/gerrit.rst (100%) rename doc/{ => source}/index.rst (100%) rename doc/{ => source}/jenkins.rst (100%) rename doc/{ => source}/jenkins_jobs.rst (100%) rename doc/{ => source}/meetbot.rst (100%) rename doc/{ => source}/puppet.rst (100%) rename doc/{ => source}/puppet_modules.rst (100%) rename doc/{ => source}/systems.rst (100%) rename doc/{ => source}/third_party.rst (100%) create mode 100644 setup.cfg diff --git a/.gitignore b/.gitignore index ab78b7bac7..1315119761 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,8 @@ *~ *.pyc applytest -build/ -doc/html/ +doc/build/ manifests/secrets.pp +.tox/ +openstack_ci_puppet.egg-info/ diff --git a/doc/conf.py b/doc/source/conf.py similarity index 100% rename from doc/conf.py rename to doc/source/conf.py diff --git a/doc/gerrit.rst b/doc/source/gerrit.rst similarity index 100% rename from doc/gerrit.rst rename to doc/source/gerrit.rst diff --git a/doc/index.rst b/doc/source/index.rst similarity index 100% rename from doc/index.rst rename to doc/source/index.rst diff --git a/doc/jenkins.rst b/doc/source/jenkins.rst similarity index 100% rename from doc/jenkins.rst rename to doc/source/jenkins.rst diff --git a/doc/jenkins_jobs.rst b/doc/source/jenkins_jobs.rst similarity index 100% rename from doc/jenkins_jobs.rst rename to doc/source/jenkins_jobs.rst diff --git a/doc/meetbot.rst b/doc/source/meetbot.rst similarity index 100% rename from doc/meetbot.rst rename to doc/source/meetbot.rst diff --git a/doc/puppet.rst b/doc/source/puppet.rst similarity index 100% rename from doc/puppet.rst rename to doc/source/puppet.rst diff --git a/doc/puppet_modules.rst b/doc/source/puppet_modules.rst similarity index 100% rename from doc/puppet_modules.rst rename to doc/source/puppet_modules.rst diff --git a/doc/systems.rst b/doc/source/systems.rst similarity index 100% rename from doc/systems.rst rename to doc/source/systems.rst diff --git a/doc/third_party.rst b/doc/source/third_party.rst similarity index 100% rename from doc/third_party.rst rename to doc/source/third_party.rst diff --git a/modules/openstack_project/files/jenkins_job_builder/config/openstack-ci-puppet.yaml b/modules/openstack_project/files/jenkins_job_builder/config/openstack-ci-puppet.yaml index 6da9e6d6e6..b4b73da3c6 100644 --- a/modules/openstack_project/files/jenkins_job_builder/config/openstack-ci-puppet.yaml +++ b/modules/openstack_project/files/jenkins_job_builder/config/openstack-ci-puppet.yaml @@ -42,3 +42,25 @@ publishers: - console-log + + +# This is a non-standard docs job because it uses SCP instead of FTP +- job: + name: ci-docs + node: precise + + triggers: + - zuul-post + + builders: + - gerrit-git-prep + - docs + + publishers: + - scp: + site: '173.203.107.207' + files: + - target: 'ci' + source: 'doc/build/html/**/*' + keep-hierarchy: true + - console-log-post diff --git a/modules/openstack_project/files/zuul/layout.yaml b/modules/openstack_project/files/zuul/layout.yaml index 348a09679a..0f86fb5c14 100644 --- a/modules/openstack_project/files/zuul/layout.yaml +++ b/modules/openstack_project/files/zuul/layout.yaml @@ -188,6 +188,8 @@ projects: - gate-ci-puppet-merge: - gate-ci-puppet-syntax - gate-ci-puppet-lint + post: + - ci-docs - name: openstack-ci/puppet-apparmor check: diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000000..11d2c44221 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,4 @@ +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source diff --git a/setup.py b/setup.py index 27ab208d47..44095cae07 100644 --- a/setup.py +++ b/setup.py @@ -16,7 +16,7 @@ try: except Exception: pass -setup(name='nova', +setup(name='openstack-ci-puppet', version="%d.%02d" % (datetime.datetime.now().year, datetime.datetime.now().month), description="OpenStack Continuous Integration Scripts", diff --git a/tox.ini b/tox.ini index a898107f9d..8c06a6429e 100644 --- a/tox.ini +++ b/tox.ini @@ -8,3 +8,7 @@ commands = pyflakes modules setup.py [testenv:pep8] deps = pep8 commands = pep8 --count --repeat --show-source --exclude=.tox setup.py + +[testenv:venv] +commands = {posargs} +deps = Sphinx