diff options
author | Rich Bennett <rb2745@att.com> | 2017-08-11 14:18:48 -0400 |
---|---|---|
committer | Rich Bennett <rb2745@att.com> | 2017-08-14 17:07:17 +0000 |
commit | 5768a9216a604f37c5ae473afccb685e1ceee72d (patch) | |
tree | 98af6fd2582bfcfbfde4309b1da2e9a9ea7510c8 /jjb | |
parent | e0bd61c493fe3871a2d81d92a70e795d58dc4bba (diff) |
Add DOC project JJB jobs and RTD job templates
Job template for verify sphinx/restructured text source
Job template for merge/publish to readthedocs.io
Issue-ID: DOC-12
Change-Id: Id344df0f4a0c517ca3ca80dff1631560ec5c2a71
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'jjb')
-rw-r--r-- | jjb/doc/doc-post-rtd.sh | 9 | ||||
-rw-r--r-- | jjb/doc/doc-templates-rtd.yaml | 143 | ||||
-rw-r--r-- | jjb/doc/doc.yaml | 17 |
3 files changed, 169 insertions, 0 deletions
diff --git a/jjb/doc/doc-post-rtd.sh b/jjb/doc/doc-post-rtd.sh new file mode 100644 index 000000000..5c8d8c52f --- /dev/null +++ b/jjb/doc/doc-post-rtd.sh @@ -0,0 +1,9 @@ +#!/bin/bash +if [ "$GERRIT_BRANCH" == "master" ]; then + RTD_BUILD_VERSION=latest +else + RTD_BUILD_VERSION="${{GERRIT_BRANCH/\//-}}" +fi + +# shellcheck disable=SC1083 +curl -X POST --data "version_slug=$RTD_BUILD_VERSION" https://readthedocs.org/build/{rtdproject} diff --git a/jjb/doc/doc-templates-rtd.yaml b/jjb/doc/doc-templates-rtd.yaml new file mode 100644 index 000000000..4f54322cd --- /dev/null +++ b/jjb/doc/doc-templates-rtd.yaml @@ -0,0 +1,143 @@ +--- +- job-template: + # Job template for verifying Sphinx/Restructured Text for RTD + # + # The purpose of this job template is verify documentation source + # + # Required Variables: + # branch: git branch + # Optional Variables: + # path: directory containing the project's tox.ini relative to + # the workspace. The default is the project root. + # pattern: ant file-path pattern relative to the workspace used to + # trigger the job + + name: '{project-name}-{stream}-verify-rtd' + path: '$WORKSPACE' + + project-type: freestyle + concurrent: true + node: '{build-node}' + + properties: + - infra-properties: + build-days-to-keep: '{build-days-to-keep}' + + parameters: + - infra-parameters: + project: '{project}' + branch: '{branch}' + refspec: 'refs/heads/{branch}' + artifacts: '{archive-artifacts}' + - maven-exec: + maven-version: '{maven-version}' + + scm: + - gerrit-trigger-scm: + refspec: '$GERRIT_REFSPEC' + choosing-strategy: 'gerrit' + submodule-recursive: '{submodule-recursive}' + + wrappers: + - infra-wrappers: + build-timeout: '{build-timeout}' + + triggers: + - gerrit-trigger-patch-submitted: + server: '{server-name}' + project: '**' + branch: '{branch}' + files: 'docs/**/*.rst' + - timed: 'H H * * *' + + builders: + - shell: | + if [ "$GERRIT_PROJECT" != "doc" ]; then + cd docs/submodules/$GERRIT_PROJECT + git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD + else + git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD + fi + - shell: | + #!/bin/bash + virtualenv $WORKSPACE/venv-tox + source $WORKSPACE/venv-tox/bin/activate + pip install --upgrade pip + pip install --upgrade tox argparse + pip freeze + cd $WORKSPACE/{path} + tox + + publishers: + - infra-shiplogs: + maven-version: '{maven-version}' + +- job-template: + # Job template for merging/publishing Sphinx/Restructured Text at RTD + # + # The purpose of this job template is to trigger updates after + # a merge of documentation source in gerrit + # + # Required Variables: + # branch: git branch + # rtdproject: name of a project at readthedocs.io + # Optional Variables: + # path: directory containing the project's tox.ini relative to + # the workspace. The default is the project root. + # pattern: ant file-path pattern relative to the workspace used to + # trigger the job + + name: '{project-name}-{stream}-merge-rtd' + path: '$WORKSPACE' + + project-type: freestyle + concurrent: false + node: '{build-node}' + + properties: + - infra-properties: + build-days-to-keep: '{build-days-to-keep}' + + parameters: + - infra-parameters: + project: '{project}' + branch: '{branch}' + refspec: 'refs/heads/{branch}' + artifacts: '{archive-artifacts}' + - maven-exec: + maven-version: '{maven-version}' + + scm: + - gerrit-trigger-scm: + refspec: '$GERRIT_REFSPEC' + choosing-strategy: 'gerrit' + submodule-recursive: '{submodule-recursive}' + + wrappers: + - infra-wrappers: + build-timeout: '{build-timeout}' + + triggers: + - gerrit: + server-name: '{server-name}' + trigger-on: + - change-merged-event + - comment-added-contains-event: + comment-contains-value: 'remerge' + projects: + - project-compare-type: 'ANT' + project-pattern: '**' + branches: + - branch-compare-type: 'ANT' + branch-pattern: '**/{branch}' + file-paths: + - compare-type: ANT + pattern: docs/**/*.rst + + builders: + - shell: !include-raw: doc-post-rtd.sh + + publishers: + - infra-shiplogs: + maven-version: '{maven-version}' + diff --git a/jjb/doc/doc.yaml b/jjb/doc/doc.yaml new file mode 100644 index 000000000..40d592240 --- /dev/null +++ b/jjb/doc/doc.yaml @@ -0,0 +1,17 @@ +--- +- project: + name: doc + project-name: 'doc' + + jobs: + - '{project-name}-{stream}-verify-rtd': + build-node: centos7-basebuild-4c-4g + - '{project-name}-{stream}-merge-rtd' + + project: 'doc' + + rtdproject: 'onap' + + stream: + - master: + branch: 'master' |