From 95a6178ecfeef153b2b27bc7921105e93134b626 Mon Sep 17 00:00:00 2001 From: annegentle Date: Fri, 6 Sep 2013 15:26:53 -0500 Subject: [PATCH] Update manual publishing to new directory layout Since we moved directories around, we need to duplicate each build job to have one for new layout (master) and one for old (folsom/grizzly). The old jobs have "-old" suffix. The patch has changed these guides: * Basic Install Guide: Build only for Folsom/Grizzly, remove openSUSE * Install Guide: Duplicated for old branches, added openSUSE * User Guide: Fixed for directory layout (only exists on master) * Compute Admin: Build only for Folsom/Grizzly * Config Guide: Fixed for directory layout (only exists on master) * High Availability Guide: Fixed for directory layout (only exists on master) * Image Guide: Fixed for directory layout (only exists on master) * Security Guide: Fixed for directory layout * Training Guide: Fixed for directory layout * Networking Guide: Duplicated for old branches * Admin User Guide: Newly added * Rename admin-guide-netconn to admin-guide-network to match directory * Move glossary pom.xml from common/glossary to glossary Will need the openstack-manuals repo to change first Partial-Bug: #1220407 Change-Id: Id634e9fec770151c3ba5745bfcab802fb6c13efe --- .../jenkins_job_builder/config/manuals.yaml | 284 +++++++++++++----- .../openstack_project/files/zuul/layout.yaml | 61 +++- 2 files changed, 263 insertions(+), 82 deletions(-) diff --git a/modules/openstack_project/files/jenkins_job_builder/config/manuals.yaml b/modules/openstack_project/files/jenkins_job_builder/config/manuals.yaml index 695d0c761b..6147d85668 100644 --- a/modules/openstack_project/files/jenkins_job_builder/config/manuals.yaml +++ b/modules/openstack_project/files/jenkins_job_builder/config/manuals.yaml @@ -11,7 +11,7 @@ root-module: group-id: org.openstack.docs artifact-id: openstack-guide - root-pom: openstack-ops/pom.xml + root-pom: doc/openstack-ops/pom.xml goals: 'clean generate-sources' publishers: @@ -20,7 +20,7 @@ site: 'static.openstack.org' files: - target: 'docs-draft/$LOG_PATH/ops/' - source: 'openstack-ops/target/docbkx/webhelp/**' + source: 'doc/openstack-ops/target/docbkx/webhelp/**' keep-hierarchy: true copy-after-failure: true @@ -35,6 +35,7 @@ publishers: - console-log +# in zuul/layout.yaml specified to only run against master branch - job: name: openstack-user-guide project-type: maven @@ -48,18 +49,19 @@ root-module: group-id: org.openstack.docs artifact-id: openstack-guide - root-pom: doc/src/docbkx/openstack-user/pom.xml + root-pom: doc/user-guide/pom.xml goals: 'clean generate-sources' publishers: - console-log - ftp: site: docs.openstack.org - source: 'doc/src/docbkx/openstack-user/target/docbkx/webhelp/user-guide/**' + source: 'doc/user-guide/target/docbkx/webhelp/user-guide/**' target: '' - remove-prefix: 'doc/src/docbkx/openstack-user/target/docbkx/webhelp/' + remove-prefix: 'doc/user-guide/target/docbkx/webhelp/' excludes: '**/*.xml,**/null*' + - job: name: openstack-admin-guide-cloud project-type: maven @@ -79,20 +81,54 @@ root-module: group-id: org.openstack.docs artifact-id: openstack-guide - root-pom: doc/src/docbkx/admin-guide-cloud/pom.xml + root-pom: doc/admin-guide-cloud/pom.xml goals: '-Dcomments.enabled=${DOC_COMMENTS_ENABLED} clean generate-sources' publishers: - console-log - ftp: site: docs.openstack.org - source: 'doc/src/docbkx/admin-guide-cloud/target/docbkx/webhelp/**' + source: 'doc/admin-guide-cloud/target/docbkx/webhelp/**' target: 'cloud-admin' - remove-prefix: 'doc/src/docbkx/admin-guide-cloud/target/docbkx/webhelp/' + remove-prefix: 'doc/admin-guide-cloud/target/docbkx/webhelp/' excludes: '**/*.xml,**/null*' +# in zuul/layout.yaml specified to only run against master - job: - name: openstack-basic-install-fedora + name: openstack-user-guide-admin + project-type: maven + concurrent: false + node: precise + + prebuilders: + - gerrit-git-prep + + properties: + - inject: + script-file: /usr/local/jenkins/slave_scripts/docbook-properties.sh + properties-file: gerrit-doc.properties + + maven: + maven-name: Maven3 + root-module: + group-id: org.openstack.docs + artifact-id: openstack-guide + root-pom: doc/user-guide-admin/pom.xml + goals: '-Dcomments.enabled=${DOC_COMMENTS_ENABLED} clean generate-sources' + + publishers: + - console-log + - ftp: + site: docs.openstack.org + source: 'doc/user-guide-admin/target/docbkx/webhelp/**' + target: 'cloud-admin' + remove-prefix: 'doc/user-guide-admin/target/docbkx/webhelp/' + excludes: '**/*.xml,**/null*' + +# in zuul/layout.yaml specified to only run against stable/folsom and grizzly +# branches. +- job: + name: openstack-basic-install-fedora-old project-type: maven node: precise @@ -121,42 +157,11 @@ remove-prefix: 'doc/src/docbkx/basic-install/target/docbkx/webhelp/' excludes: '**/*.xml,**/null*' -# in zuul/layout.yaml specified to only run against master branch. + +# in zuul/layout.yaml specified to only run against stable/folsom and grizzly +# branches. - job: - name: openstack-basic-install-opensuse - project-type: maven - node: precise - - prebuilders: - - gerrit-git-prep - - properties: - - inject: - script-file: /usr/local/jenkins/slave_scripts/docbook-properties.sh - properties-file: gerrit-doc.properties - - prebuilders: - - gerrit-git-prep - - maven: - maven-name: Maven3 - root-module: - group-id: org.openstack.docs - artifact-id: openstack-guide - root-pom: doc/src/docbkx/basic-install/pom.xml - goals: '-Doperating.system=zypper -Dprofile.os=opensuse -Drelease.path.name=${DOC_RELEASE_PATH} -Dcomments.enabled=${DOC_COMMENTS_ENABLED} clean generate-sources' - - publishers: - - console-log - - ftp: - site: docs.openstack.org - source: 'doc/src/docbkx/basic-install/target/docbkx/webhelp/**' - target: '' - remove-prefix: 'doc/src/docbkx/basic-install/target/docbkx/webhelp/' - excludes: '**/*.xml,**/null*' - -- job: - name: openstack-basic-install-ubuntu + name: openstack-basic-install-ubuntu-old project-type: maven node: precise @@ -189,7 +194,7 @@ excludes: '**/*.xml,**/null*' - job: - name: openstack-admin-manual-block + name: openstack-admin-manual-block-old project-type: maven node: precise @@ -231,18 +236,19 @@ root-module: group-id: org.openstack.docs artifact-id: openstack-guide - root-pom: doc/src/docbkx/common/glossary/pom.xml + root-pom: doc/glossary/pom.xml goals: 'clean generate-sources' publishers: - console-log - ftp: site: docs.openstack.org - source: 'doc/src/docbkx/common/glossary/target/docbkx/webhelp/openstack-glossary/**' + source: 'doc/glossary/target/docbkx/webhelp/openstack-glossary/**' target: 'glossary' - remove-prefix: 'doc/src/docbkx/common/glossary/target/docbkx/webhelp/openstack-glossary/' + remove-prefix: 'doc/glossary/target/docbkx/webhelp/openstack-glossary/' excludes: '**/*.xml,**/null*' +# in zuul/layout.yaml specified to only run against master branch - job: name: openstack-image-guide project-type: maven @@ -262,18 +268,19 @@ root-module: group-id: org.openstack.docs artifact-id: openstack-guide - root-pom: doc/src/docbkx/openstack-image/pom.xml + root-pom: doc/image-guide/pom.xml goals: '-Drelease.path.name=${DOC_RELEASE_PATH} -Dcomments.enabled=${DOC_COMMENTS_ENABLED} clean generate-sources' publishers: - console-log - ftp: site: docs.openstack.org - source: 'doc/src/docbkx/openstack-image/target/docbkx/webhelp/**' + source: 'doc/image-guide/target/docbkx/webhelp/**' target: '/' - remove-prefix: 'doc/src/docbkx/openstack-image/target/docbkx/webhelp/' + remove-prefix: 'doc/image-guide/target/docbkx/webhelp/' excludes: '**/*.xml,**/null*' +# in zuul/layout.yaml specified to only run against master branch - job: name: openstack-config-ref project-type: maven @@ -293,21 +300,22 @@ root-module: group-id: org.openstack.docs artifact-id: openstack-guide - root-pom: doc/src/docbkx/openstack-config/pom.xml + root-pom: doc/config-reference/pom.xml goals: '-Drelease.path.name=${DOC_RELEASE_PATH} -Dcomments.enabled=${DOC_COMMENTS_ENABLED} clean generate-sources' publishers: - console-log-post - ftp: site: docs.openstack.org - source: 'doc/src/docbkx/openstack-config/target/docbkx/webhelp/**' + source: 'doc/config-reference/target/docbkx/webhelp/**' target: '/' - remove-prefix: 'doc/src/docbkx/openstack-config/target/docbkx/webhelp/' + remove-prefix: 'doc/config-reference/target/docbkx/webhelp/' excludes: '**/*.xml,**/null*' - +# in zuul/layout.yaml specified to only run against stable/folsom and grizzly +# branches. - job: - name: openstack-admin-manual-compute + name: openstack-admin-manual-compute-old project-type: maven concurrent: false node: precise @@ -337,8 +345,42 @@ remove-prefix: 'doc/src/docbkx/openstack-compute-admin/target/docbkx/webhelp/' excludes: '**/*.xml,**/null*' +# in zuul/layout.yaml specified to only run against master - job: - name: openstack-admin-manual-netconn + name: openstack-admin-manual-network + project-type: maven + concurrent: false + node: precise + + prebuilders: + - gerrit-git-prep + + properties: + - inject: + script-file: /usr/local/jenkins/slave_scripts/docbook-properties.sh + properties-file: gerrit-doc.properties + + maven: + maven-name: Maven3 + root-module: + group-id: org.openstack.docs + artifact-id: openstack-guide + root-pom: doc/admin-guide-network/pom.xml + goals: '-Drelease.path.name=${DOC_RELEASE_PATH} -Dcomments.enabled=${DOC_COMMENTS_ENABLED} clean generate-sources' + + publishers: + - console-log + - ftp: + site: docs.openstack.org + source: 'doc/admin-guide-network/target/docbkx/webhelp/**' + target: '/' + remove-prefix: 'doc/admin-guide-network/target/docbkx/webhelp/' + excludes: '**/*.xml,**/null*' + +# in zuul/layout.yaml specified to only run against stable/folsom and grizzly +# branches. +- job: + name: openstack-admin-manual-netconn-old project-type: maven concurrent: false node: precise @@ -406,27 +448,61 @@ prebuilders: - gerrit-git-prep - shell: | - asciidoc -b docbook -d book -o - doc/src/docbkx/openstack-ha/ha-guide.txt | xsltproc -o - /usr/share/xml/docbook/stylesheet/docbook5/db4-upgrade.xsl - | xmllint --format - | sed -e 's, doc/src/docbkx/openstack-ha/bk-ha-guide.xml + asciidoc -b docbook -d book -o - doc/high-availability-guide/ha-guide.txt | xsltproc -o - /usr/share/xml/docbook/stylesheet/docbook5/db4-upgrade.xsl - | xmllint --format - | sed -e 's, doc/high-availability-guide/bk-ha-guide.xml maven: maven-name: Maven3 root-module: group-id: org.openstack.docs artifact-id: openstack-guide - root-pom: doc/src/docbkx/openstack-ha/pom.xml + root-pom: doc/high-availability-guide/pom.xml goals: 'clean generate-sources' publishers: - console-log - ftp: site: docs.openstack.org - source: 'doc/src/docbkx/openstack-ha/target/docbkx/webhelp/trunk/**' + source: 'doc/high-availability-guide/target/docbkx/webhelp/trunk/**' target: 'trunk' - remove-prefix: 'doc/src/docbkx/openstack-ha/target/docbkx/webhelp/trunk/' + remove-prefix: 'doc/high-availability-guide/target/docbkx/webhelp/trunk/' excludes: '**/*.xml,**/null*' +# in zuul/layout.yaml specified to only run against master - job: - name: openstack-install-deploy-guide-apt-fedora + name: openstack-install-deploy-guide-fedora + project-type: maven + concurrent: false + node: precise + + properties: + - inject: + script-file: /usr/local/jenkins/slave_scripts/docbook-properties.sh + properties-file: gerrit-doc.properties + + prebuilders: + - gerrit-git-prep + + maven: + maven-name: Maven3 + root-module: + group-id: org.openstack.docs + artifact-id: openstack-guide + root-pom: doc/install-guide/pom.xml + goals: '-Doperating.system=yum -Dprofile.os=centos;fedora;rhel -Drelease.path.name=${DOC_RELEASE_PATH} -Dcomments.enabled=${DOC_COMMENTS_ENABLED} clean generate-sources' + + publishers: + - console-log + - ftp: + site: docs.openstack.org + source: 'doc/install-guide/target/docbkx/webhelp/**' + target: '/' + remove-prefix: 'doc/install-guide/target/docbkx/webhelp/' + excludes: '**/*.xml,**/null*' + +# in zuul/layout.yaml specified to only run against stable/folsom and grizzly +# branches. +- job: + name: openstack-install-deploy-guide-fedora-old project-type: maven concurrent: false node: precise @@ -456,12 +532,78 @@ remove-prefix: 'doc/src/docbkx/openstack-install/target/docbkx/webhelp/' excludes: '**/*.xml,**/null*' +# in zuul/layout.yaml specified to only run against master +- job: + name: openstack-install-deploy-guide-opensuse + project-type: maven + concurrent: false + node: precise + + properties: + - inject: + script-file: /usr/local/jenkins/slave_scripts/docbook-properties.sh + properties-file: gerrit-doc.properties + + prebuilders: + - gerrit-git-prep + + maven: + maven-name: Maven3 + root-module: + group-id: org.openstack.docs + artifact-id: openstack-guide + root-pom: doc/install-guide/pom.xml + goals: '-Doperating.system=zypper -Dprofile.os=opensuse -Drelease.path.name=${DOC_RELEASE_PATH} -Dcomments.enabled=${DOC_COMMENTS_ENABLED} clean generate-sources' + + publishers: + - console-log + - ftp: + site: docs.openstack.org + source: 'doc/install-guide/target/docbkx/webhelp/**' + target: '/' + remove-prefix: 'doc/install-guide/target/docbkx/webhelp/' + excludes: '**/*.xml,**/null*' + +# in zuul/layout.yaml specified to only run against master - job: name: openstack-install-deploy-guide-ubuntu project-type: maven concurrent: false node: precise + properties: + - inject: + script-file: /usr/local/jenkins/slave_scripts/docbook-properties.sh + properties-file: gerrit-doc.properties + + prebuilders: + - gerrit-git-prep + + maven: + maven-name: Maven3 + root-module: + group-id: org.openstack.docs + artifact-id: openstack-guide + root-pom: doc/install-guide/pom.xml + goals: '-Doperating.system=apt -Dprofile.os=ubuntu -Drelease.path.name=${DOC_RELEASE_PATH} -Dcomments.enabled=${DOC_COMMENTS_ENABLED} clean generate-sources' + + publishers: + - console-log + - ftp: + site: docs.openstack.org + source: 'doc/install-guide/target/docbkx/webhelp/**' + target: '/' + remove-prefix: 'doc/install-guide/target/docbkx/webhelp/' + excludes: '**/*.xml,**/null*' + +# in zuul/layout.yaml specified to only run against stable/folsom and grizzly +# branches. +- job: + name: openstack-install-deploy-guide-ubuntu-old + project-type: maven + concurrent: false + node: precise + properties: - inject: script-file: /usr/local/jenkins/slave_scripts/docbook-properties.sh @@ -506,16 +648,16 @@ root-module: group-id: org.openstack.docs artifact-id: openstack-guide - root-pom: doc/src/docbkx/openstack-ops/pom.xml + root-pom: doc/openstack-ops/pom.xml goals: '-Drelease.path.name=${DOC_RELEASE_PATH} -Dcomments.enabled=${DOC_COMMENTS_ENABLED} clean generate-sources' publishers: - console-log - ftp: site: docs.openstack.org - source: 'doc/src/docbkx/openstack-ops/target/docbkx/webhelp/**' + source: 'doc/openstack-ops/target/docbkx/webhelp/**' target: '/' - remove-prefix: 'doc/src/docbkx/openstack-ops/target/docbkx/webhelp/' + remove-prefix: 'doc/openstack-ops/target/docbkx/webhelp/' excludes: '**/*.xml,**/null*' - job: @@ -537,16 +679,16 @@ root-module: group-id: org.openstack.docs artifact-id: openstack-guide - root-pom: doc/src/docbkx/openstack-security/pom.xml + root-pom: doc/security-guide/pom.xml goals: '-Drelease.path.name=${DOC_RELEASE_PATH} -Dcomments.enabled=${DOC_COMMENTS_ENABLED} clean generate-sources' publishers: - console-log - ftp: site: docs.openstack.org - source: 'doc/src/docbkx/openstack-security/target/docbkx/webhelp/**' + source: 'doc/security-guide/target/docbkx/webhelp/**' target: '/' - remove-prefix: 'doc/src/docbkx/openstack-security/target/docbkx/webhelp/' + remove-prefix: 'doc/security-guide/target/docbkx/webhelp/' excludes: '**/*.xml,**/null*' - job: @@ -567,16 +709,16 @@ root-module: group-id: org.openstack.docs artifact-id: openstack-guide - root-pom: doc/src/docbkx/openstack-training/pom.xml + root-pom: doc/training-guide/pom.xml goals: '-Drelease.path.name=${DOC_RELEASE_PATH} -Dcomments.enabled=${DOC_COMMENTS_ENABLED} clean generate-sources' publishers: - console-log-post - ftp: site: docs.openstack.org - source: 'doc/src/docbkx/openstack-training/target/docbkx/webhelp/**' + source: 'doc/training-guide/target/docbkx/webhelp/**' target: '/' - remove-prefix: 'doc/src/docbkx/openstack-training/target/docbkx/webhelp/' + remove-prefix: 'doc/training-guide/target/docbkx/webhelp/' excludes: '**/*.xml,**/null*' - job: diff --git a/modules/openstack_project/files/zuul/layout.yaml b/modules/openstack_project/files/zuul/layout.yaml index ee07b8e10b..09d8660669 100644 --- a/modules/openstack_project/files/zuul/layout.yaml +++ b/modules/openstack_project/files/zuul/layout.yaml @@ -167,16 +167,51 @@ jobs: voting: false failure-message: Jenkins XML output has changed. success-message: Jenkins XML output is unchanged. +# Continous publishing from master of the following documentation targets: + - name: openstack-admin-guide-cloud + branch: ^master$ - name: openstack-docs-site branch: ^master$ + - name: openstack-glossary + branch: ^master$ - name: openstack-ha-guide branch: ^master$ + - name: openstack-image-guide + branch: ^master$ + - name: openstack-user-guide + branch: ^master$ + - name: openstack-user-guide-admin + branch: ^master$ - name: openstack-security-guide branch: ^master$ - - name: openstack-basic-install-opensuse - branch: ^master$ - - name: openstack-admin-guide-cloud + - name: openstack-training branch: ^master$ +# Documentation targets for master and future stable branches: + - name: openstack-admin-manual-network + branch: ^(?!stable/(folsom|grizzly)).*$ + - name: openstack-config-ref + branch: ^(?!stable/(folsom|grizzly)).*$ + - name: openstack-install-deploy-guide-fedora + branch: ^(?!stable/(folsom|grizzly)).*$ + - name: openstack-install-deploy-guide-opensuse + branch: ^(?!stable/(folsom|grizzly)).*$ + - name: openstack-install-deploy-guide-ubuntu + branch: ^(?!stable/(folsom|grizzly)).*$ +# Deprecated documentation targets: + - name: openstack-admin-manual-block-old + branch: stable/(grizzly|folsom) + - name: openstack-admin-manual-compute-old + branch: stable/(grizzly|folsom) + - name: openstack-admin-manual-netconn-old + branch: stable/(grizzly|folsom) + - name: openstack-basic-install-fedora-old + branch: stable/(grizzly|foslom) + - name: openstack-basic-install-ubuntu-old + branch: stable/(grizzly|folsom) + - name: openstack-install-deploy-guide-fedora-old + branch: stable/(grizzly|folsom) + - name: openstack-install-deploy-guide-ubuntu-old + branch: stable/(grizzly|folsom) - name: ^gate-.*-docs$ success-pattern: http://docs-draft.openstack.org/{build.parameters[LOG_PATH]}/doc/build/html/ - name: infra-publications-publish @@ -1852,21 +1887,25 @@ projects: - gate-openstack-manuals-validate post: - openstack-admin-guide-cloud - - openstack-admin-manual-compute - - openstack-admin-manual-netconn - - openstack-admin-manual-block - - openstack-user-guide - - openstack-basic-install-fedora - - openstack-basic-install-opensuse - - openstack-basic-install-ubuntu + - openstack-admin-manual-compute-old + - openstack-admin-manual-netconn-old + - openstack-admin-manual-block-old + - openstack-basic-install-fedora-old + - openstack-basic-install-ubuntu-old + - openstack-admin-manual-network - openstack-glossary - openstack-image-guide - openstack-config-ref - openstack-docs-site - openstack-ha-guide - - openstack-install-deploy-guide-apt-fedora + - openstack-install-deploy-guide-fedora + - openstack-install-deploy-guide-fedora-old + - openstack-install-deploy-guide-opensuse - openstack-install-deploy-guide-ubuntu + - openstack-install-deploy-guide-ubuntu-old - openstack-security-guide + - openstack-user-guide + - openstack-user-guide-admin - manuals-upstream-translation-update - openstack-training periodic: