1 # Build documentation and web page.
4 # Built by admin/dockerfiles/ci-docs-clang
5 # TODO this should be organized more like the current documentation.py script
6 image: gromacs/ci-docs-clang:master
9 - .gromacs:base:configure
11 - .before_script:default
19 KUBERNETES_CPU_LIMIT: 1
20 KUBERNETES_CPU_REQUEST: 1
21 KUBERNETES_MEMORY_LIMIT: 2Gi
22 CMAKE_COMPILER_SCRIPT: "-DCMAKE_C_COMPILER=clang-7 -DCMAKE_CXX_COMPILER=clang++-7"
23 CMAKE_EXTRA_OPTIONS: ""
24 CMAKE_SIMD_OPTIONS: "-DGMX_SIMD=None"
25 CMAKE_MPI_OPTIONS: "-DGMX_THREAD_MPI=OFF"
26 CMAKE_PRECISION_OPTIONS: "-DGMX_DOUBLE=OFF"
27 CMAKE_BUILD_TYPE_OPTIONS: "-DCMAKE_BUILD_TYPE=Debug"
28 CMAKE_GPU_OPTIONS: "-DGMX_GPU=OFF"
30 - if [[ ! -z $GROMACS_RELEASE && $GROMACS_RELEASE == "true" ]] ; then
31 REL_OPTION="-DGMX_BUILD_TARBALL=ON" ;
33 REL_OPTION="-DGMX_BUILD_TARBALL=OFF" ;
35 - echo $CMAKE_COMPILER_SCRIPT
36 - echo $CMAKE_EXTRA_OPTIONS
37 - echo $CMAKE_SIMD_OPTIONS
38 - echo $CMAKE_GPU_OPTIONS
39 - echo $CMAKE_MPI_OPTIONS
40 - echo $CMAKE_PRECISION_OPTIONS
41 - echo $CMAKE_BUILD_TYPE_OPTIONS
42 - echo $CMAKE_GMXAPI_OPTIONS
44 - if [[ -d $BUILD_DIR ]] ; then
45 rm -rf $BUILD_DIR && mkdir $BUILD_DIR ;
47 echo "Preparing new build directory" ;
52 -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache
53 $CMAKE_COMPILER_SCRIPT
57 $CMAKE_PRECISION_OPTIONS
58 $CMAKE_BUILD_TYPE_OPTIONS
62 -DCMAKE_INSTALL_PREFIX=../$INSTALL_DIR -DGMX_COMPILER_WARNINGS=ON
63 2>&1 | tee cmakeLog.log
64 - awk '/CMake Warning/,/^--|^$/' cmakeLog.log | tee cmakeErrors.log
65 - if [ -s cmakeErrors.log ] ; then echo "Found CMake warning while processing build"; cat cmakeErrors.log ; exit 1; fi
68 name: docs-artifacts-$CI_COMMIT_REF_SLUG
74 .docs:configure:release:
75 # Built by admin/dockerfiles/ci-docs-clang
76 # TODO this should be organized more like the current documentation.py script
77 image: gromacs/ci-docs-clang:master
78 stage: release-configure
80 - .gromacs:base:configure
82 - .before_script:default
85 KUBERNETES_CPU_LIMIT: 1
86 KUBERNETES_CPU_REQUEST: 1
87 KUBERNETES_MEMORY_LIMIT: 2Gi
88 CMAKE_COMPILER_SCRIPT: "-DCMAKE_C_COMPILER=clang-7 -DCMAKE_CXX_COMPILER=clang++-7"
89 CMAKE_EXTRA_OPTIONS: ""
90 CMAKE_SIMD_OPTIONS: "-DGMX_SIMD=None"
91 CMAKE_MPI_OPTIONS: "-DGMX_THREAD_MPI=ON"
92 CMAKE_PRECISION_OPTIONS: "-DGMX_DOUBLE=OFF"
93 CMAKE_BUILD_TYPE_OPTIONS: "-DCMAKE_BUILD_TYPE=Debug"
94 CMAKE_GPU_OPTIONS: "-DGMX_GPU=OFF"
95 RELEASE_BUILD_DIR: release-doc-builds
96 RELEASE_SOURCE: release-source-from-tarball
97 RELEASE_REGRESSIONTESTS: release-regressiontests-from-tarball
107 - if [[ $GROMACS_RELEASE == "true" ]] ; then
108 REL_OPTION="-DGMX_BUILD_TARBALL=ON" ;
110 REL_OPTION="-DGMX_BUILD_TARBALL=OFF" ;
112 - echo $CMAKE_COMPILER_SCRIPT
113 - echo $CMAKE_EXTRA_OPTIONS
114 - echo $CMAKE_SIMD_OPTIONS
115 - echo $CMAKE_GPU_OPTIONS
116 - echo $CMAKE_MPI_OPTIONS
117 - echo $CMAKE_PRECISION_OPTIONS
118 - echo $CMAKE_BUILD_TYPE_OPTIONS
119 - echo $CMAKE_GMXAPI_OPTIONS
121 - VERSION=`cat version.json |
122 python3 -c "import json,sys; print(json.load(sys.stdin)['version'])"`
123 - if [[ $GROMACS_RELEASE != "true" ]] ; then
124 VERSION=$VERSION-dev ;
126 - REGTEST_COMPARE=`cat version.json |
127 python3 -c "import json,sys; print(json.load(sys.stdin)['regressiontest-md5sum'])"`
128 - SOURCENAME=gromacs-$VERSION
129 - SOURCETARBALL=$SOURCENAME.tar.gz
130 - REGTESTNAME=regressiontests-$VERSION
131 - REGTESTTARBALL=$REGTESTNAME.tar.gz
132 - SOURCE_MD5SUM=`md5sum $SOURCETARBALL | awk '{print $1}'`
133 - RELEASE_TARBALLS=release-tarballs
134 - rm -rf $RELEASE_TARBALLS $RELEASE_SOURCE $RELEASE_REGRESSIONTESTS && mkdir $RELEASE_TARBALLS
135 - mv $SOURCETARBALL $RELEASE_TARBALLS
136 - mv $REGTESTTARBALL $RELEASE_TARBALLS
137 - cd $RELEASE_TARBALLS
138 # We rename the source and regressiontest directories
139 # to have names for them that don't change for different versions.
140 - tar -xf $SOURCETARBALL
141 - mv $SOURCENAME ../$RELEASE_SOURCE
142 - tar -xf $REGTESTTARBALL
143 - mv $REGTESTNAME ../$RELEASE_REGRESSIONTESTS
144 - rm $SOURCETARBALL $REGTESTTARBALL
146 - echo $CMAKE_COMPILER_SCRIPT
147 - echo $CMAKE_EXTRA_OPTIONS
148 - echo $CMAKE_SIMD_OPTIONS
149 - echo $CMAKE_GPU_OPTIONS
150 - echo $CMAKE_MPI_OPTIONS
151 - echo $CMAKE_PRECISION_OPTIONS
152 - echo $CMAKE_BUILD_TYPE_OPTIONS
153 - echo $CMAKE_GMXAPI_OPTIONS
154 - if [[ -d $RELEASE_BUILD_DIR ]] ; then
155 echo "Cleaning up build directory" ;
156 rm -rf $RELEASE_BUILD_DIR && mkdir $RELEASE_BUILD_DIR ;
158 echo "Preparing new build directory" ;
159 mkdir $RELEASE_BUILD_DIR ;
161 - cd $RELEASE_BUILD_DIR
162 - cmake ../$RELEASE_SOURCE/
163 -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache
164 $CMAKE_COMPILER_SCRIPT
168 $CMAKE_PRECISION_OPTIONS
169 $CMAKE_BUILD_TYPE_OPTIONS
171 $CMAKE_GMXAPI_OPTIONS
173 "-DSOURCE_MD5SUM=$SOURCE_MD5SUM"
174 "-DREGRESSIONTEST_PATH=../$RELEASE_REGRESSIONTESTS"
175 -DCMAKE_INSTALL_PREFIX=../$INSTALL_DIR -DGMX_COMPILER_WARNINGS=ON
176 2>&1 | tee cmakeLog.log
177 - awk '/CMake Warning/,/^--|^$/' cmakeLog.log | tee cmakeErrors.log
178 - if [ -s cmakeErrors.log ] ; then echo "Found CMake warning while processing build"; cat cmakeErrors.log ; exit 1; fi
181 name: docs-artifacts-$CI_COMMIT_REF_SLUG
186 - $RELEASE_REGRESSIONTESTS
196 BUILD_DIR: build-docs
197 CMAKE_EXTRA_OPTIONS: -DGMX_BUILD_HELP=on -DGMX_BUILD_MANUAL=on
203 # Built by admin/dockerfiles/ci-docs-clang
204 # TODO this should be organized more like the current documentation.py script
205 image: gromacs/ci-docs-clang:master
214 - cmake --build . --target gmx -- -j8
217 name: docs-artifacts-$CI_COMMIT_REF_SLUG
225 - .gromacs:base:build
229 - .before_script:default
234 - job: docs:configure
237 BUILD_DIR: build-docs
242 # The manual build is built separately so that errors in converting
243 # Sphinx to LaTeX and compiling can always be found in the
244 # all-output.txt file, while avoiding many thousands of lines of spam
245 # from pdflatex for normal builds. This does reduce the available
246 # parallel utilization, and so increases the build time.
248 # TODO why are the doxygen and sphinx log files disappearing
249 # TODO use a feature from gitlab runner instead of using pipefail to get timings for the job
252 - .gromacs:base:build
254 - .before_script:default
255 # Built by admin/dockerfiles/ci-docs-clang
256 # TODO this should be organized more like the current documentation.py script
257 image: gromacs/ci-docs-clang:master
265 KUBERNETES_CPU_LIMIT: 4
266 KUBERNETES_CPU_REQUEST: 2
267 KUBERNETES_MEMORY_LIMIT: 4Gi
270 - cmake --build . --target manual -- -j4 | tee docs/manual/all-output.log
271 | grep -i "warning" | grep -v "TeX" | grep -v "Package" || true
272 - cmake --build . --target webpage -- -j4
273 - grep "WARNING:" docs/manual/all-output.log | tee pythonErrors.log || true
274 - grep -i "error" docs/sphinx-*.log | tee sphinxDiagnostics.log || true
275 - grep -i "warning" docs/sphinx-*.log | tee -a sphinxDiagnostics.log || true
276 - if [ -s pythonErrors.log ] ; then echo "Found Python Errors during build"; exit 1; fi
277 - if [ -s sphinxErrors.log ] ; then echo "Found errors during Sphinx documentation build"; cat sphinxErrors.log; exit 1; fi
278 - if [ -s sphinxDiagnostics.log ] ; then echo "Found diagnostic warnings during Sphinx documentation build"; cat sphinxDiagnostics.log; exit 1; fi
281 name: docs-artifacts-$CI_COMMIT_REF_SLUG
286 - $BUILD_DIR/docs/html
287 - $BUILD_DIR/docs/manual/gromacs.log
288 - $BUILD_DIR/docs/manual/all-output.log
289 - $BUILD_DIR/docs/doxygen/doxygen-user.log
290 - $BUILD_DIR/docs/doxygen/doxygen-lib.log
291 - $BUILD_DIR/docs/doxygen/doxygen-full.log
292 - $BUILD_DIR/docs/sphinx-html.log
304 BUILD_DIR: build-docs
311 - .docs:configure:release
322 - regressiontests:package
323 - prepare-release-version
325 CMAKE_EXTRA_OPTIONS: -DGMX_BUILD_HELP=on -DGMX_BUILD_MANUAL=on
328 webpage:dependencies:
330 - .gromacs:base:build
334 - .before_script:default
337 - job: webpage:configure
340 BUILD_DIR: release-doc-builds
349 webpage:build:release:
353 - webpage:dependencies
355 stage: release-prepare-deploy
364 BUILD_DIR: release-doc-builds