summaryrefslogtreecommitdiffstats
path: root/jjb/opnfvdocs/opnfvdocs.yml
blob: 94ca6fc4396ab71c1dd5d8418bfee0df0cf627de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
########################
# Job configuration for opnfvdocs
########################
- project:

    name: opnfvdocs

    project: '{name}'

    jobs:
        - 'opnfvdocs-verify-{stream}'
        - 'opnfvdocs-merge-{stream}'
        - 'opnfvdocs-daily-{stream}'

    stream:
        - master:
            branch: '{stream}'
            gs-pathname: ''
        - brahmaputra:
            branch: 'stable/{stream}'
            gs-pathname: '/{stream}'

########################
# job templates
########################

- job-template:
    name: 'opnfvdocs-verify-{stream}'

    parameters:
        - project-parameter:
            project: $GERRIT_PROJECT
        - gerrit-parameter:
            branch: '{branch}'
        - string:
            name: GIT_CLONE_BASE
            default: ssh://gerrit.opnfv.org:29418
            description: "Used for overriding the GIT URL coming from parameters macro."

    scm:
        - gerrit-trigger-scm:
            credentials-id: '{ssh-credentials}'
            refspec: '$GERRIT_REFSPEC'
            choosing-strategy: 'gerrit'

    triggers:
        - gerrit:
            trigger-on:
                - patchset-created-event:
                    exclude-drafts: 'false'
                    exclude-trivial-rebase: 'false'
                    exclude-no-code-change: 'false'
                - draft-published-event
                - comment-added-contains-event:
                    comment-contains-value: 'recheck'
                - comment-added-contains-event:
                    comment-contains-value: 'reverify'
            projects:
              - project-compare-type: 'REG_EXP'
                project-pattern: '{project}'
                branches:
                  - branch-compare-type: 'ANT'
                    branch-pattern: '**/{branch}'
                file-paths:
                  - compare-type: ANT
                    pattern: 'docs/**'

    builders:
        - clone-opnfv-repos
        - build-html-and-pdf-docs-output
        - upload-under-review-docs-to-opnfv-artifacts
        - report-docs-build-result-to-gerrit

- job-template:
    name: 'opnfvdocs-merge-{stream}'

    parameters:
        - project-parameter:
            project: $GERRIT_PROJECT
        - gerrit-parameter:
            branch: '{branch}'
        - string:
            name: GIT_CLONE_BASE
            default: ssh://gerrit.opnfv.org:29418
            description: "Used for overriding the GIT URL coming from parameters macro."
        - string:
            name: GS_URL
            default: '$GS_BASE{gs-pathname}'
            description: "Directory where the build artifact will be located upon the completion of the build."

    scm:
        - gerrit-trigger-scm:
            credentials-id: '{ssh-credentials}'
            refspec: '$GERRIT_REFSPEC'
            choosing-strategy: 'gerrit'

    triggers:
        - gerrit:
            trigger-on:
                - change-merged-event
                - comment-added-contains-event:
                    comment-contains-value: 'remerge'
            projects:
              - project-compare-type: 'REG_EXP'
                project-pattern: '{project}'
                branches:
                  - branch-compare-type: 'ANT'
                    branch-pattern: '**/{branch}'
                file-paths:
                  - compare-type: ANT
                    pattern: 'docs/**'

    builders:
        - clone-opnfv-repos
        - build-html-and-pdf-docs-output
#        - upload-generated-docs-to-opnfv-artifacts
        - report-docs-build-result-to-gerrit
        - remove-old-docs-from-opnfv-artifacts

- job-template:
    name: 'opnfvdocs-daily-{stream}'

    parameters:
        - project-parameter:
            project: '{project}'
        - string:
            name: GS_URL
            default: '$GS_BASE{gs-pathname}'
            description: "Directory where the build artifact will be located upon the completion of the build."
        - string:
            name: GIT_CLONE_BASE
            default: ssh://gerrit.opnfv.org:29418
            description: "Used for overriding the GIT URL coming from parameters macro."
        - string:
            name: GERRIT_BRANCH
            default: '{branch}'
            description: 'Specify the branch in this way in order to be able to use clone-opnfv-repos builder.'

    scm:
        - git-scm:
            credentials-id: '{ssh-credentials}'
            refspec: ''
            branch: '{branch}'

    triggers:
        - timed: '0 H/6 * * *'

    builders:
        - clone-opnfv-repos
        - build-html-and-pdf-docs-output
#        - upload-generated-docs-to-opnfv-artifacts

- builder:
    name: clone-opnfv-repos

    # TODO(r-mibu): fix job name which is not relevant anymore
    #               AND move this script into opnfvdocs repo

    builders:
        - shell: |
            #!/bin/bash
            set -o errexit
            set -o nounset
            set -o pipefail

            tmp=$WORKSPACE/composite_tmp
            [[ -d $tmp ]] && rm -rf $tmp
            mkdir -p $tmp
            mkdir -p $WORKSPACE/docs/projects

            pushd $tmp

            # clone releng repo to get repo list
            echo "Cloning releng repo"
            git clone $GIT_CLONE_BASE/releng --branch master --depth 1 --quiet
            repos=$(grep -v '^#' releng/jjb/opnfvdocs/project.cfg | sort)

            echo
            echo "Cloning repos of participating OPNFV Projects and copying docs"
            echo
            echo "--------------------------------------------------------"
            for repo in $repos; do
                echo "    $repo ($GERRIT_BRANCH)"
                git clone $GIT_CLONE_BASE/$repo --branch $GERRIT_BRANCH --depth 1 --quiet
                cp -r $repo/docs $WORKSPACE/docs/projects/$repo
            done
            echo "--------------------------------------------------------"
            echo

            echo "Creating document links"
            for guide in configguide userguide
            do
                link_list=$WORKSPACE/docs/$guide/projects-$guide.rst
                for repo in $repos
                do
                    file=projects/$repo/$guide/$guide.rst
                    [[ -e $WORKSPACE/docs/$file ]] || continue
                    echo "" >> $link_list
                    echo "$repo:" >> $link_list
                    echo ".. include:: ../$file" >> $link_list
                done
            done

            popd
            rm -rf $tmp

            echo "Done"