pages.sh: use pages docker image to run on gitlab instance runners

.gitlab/Dockerfile-pages

+#
+#  @file Dockerfile-pages
+#
+#  @copyright 2024-2024 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
+#                       Univ. Bordeaux. All rights reserved.
+#
+#  @version 1.3.0
+#  @author Florent Pruvost
+#  @date 2024-12-02
+#
+# This docker image is used to test the package during gitlab-ci pipelines.
+# It should be stored in the gitlab's project container registry:
+# https://gitlab.inria.fr/solverstack/chameleon/container_registry
+#
+FROM registry.gitlab.inria.fr/solverstack/chameleon
+
+USER root
+
+# Chameleon tools/pages.sh script additional dependencies
+RUN apt-get -y upgrade --no-install-recommends \
+    emacs \
+    emacs-goodies-el \
+    elpa-htmlize \
+    python3-click \
+    python3-elasticsearch \
+    python3-pandas \
+    r-cran-ggplot2 \
+    r-cran-plyr \
+    r-cran-reshape2
+
+RUN apt-get autoremove -y
+RUN apt-get autoclean -y
+RUN apt-get purge -y
+
+USER gitlab

.gitlab/docker.yml

 ---
-docker:
+.docker_script_common:
   stage: docker
   image: docker
   when: manual
   before_script:
     - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
   script:
-    - docker build -f .gitlab/Dockerfile -t $CI_REGISTRY_IMAGE $PWD
-    - docker push $CI_REGISTRY_IMAGE
+    - docker build -f $IMAGE_FILE -t $IMAGE_NAME $PWD
+    - docker push $IMAGE_NAME
+
+docker-tests:
+  extends: .docker_script_common
+  variables:
+    IMAGE_FILE: .gitlab/Dockerfile
+    IMAGE_NAME: $CI_REGISTRY_IMAGE
+
+docker-pages:
+  extends: .docker_script_common
+  variables:
+    IMAGE_FILE: .gitlab/Dockerfile-pages
+    IMAGE_NAME: $CI_REGISTRY_IMAGE/pages

.gitlab/pages.yml

 ---
 pages:
   stage: deploy
+  image: $CI_REGISTRY_IMAGE/pages
   extends: .only-master
   needs: [coverage_master]
+  variables:
+    VERSION: pages
+  script:
+    - ./tools/pages.sh
   artifacts:
     name: "$CI_JOB_NAME-$CI_COMMIT_REF_SLUG"
     expire_in: 1 week
     paths:
       - public
-  variables:
-    VERSION: pages
-  script:
-    - ./tools/pages.sh

doc/user/homepage.org

@@ -6,7 +6,7 @@
 #+OPTIONS: H:3 num:t \n:nil @:t ::t |:t _:nil ^:nil -:t f:t *:t <:t
 #+OPTIONS: TeX:t LaTeX:t skip:nil d:nil pri:nil tags:not-in-toc html-style:nil
 # #+HTML_LINK_HOME: https://solverstack.gitlabpages.inria.fr/chameleon/
-#+SETUPFILE: https://mfelsoci.gitlabpages.inria.fr/inria-org-html-themes/online-theme-readtheorginria.setup
+#+SETUPFILE: https://solverstack.gitlabpages.inria.fr/inria-org-html-themes/online-theme-readtheorginria.setup
 
 * Overview
 :PROPERTIES:

doc/user/publish.el

@@ -9,6 +9,8 @@
 (require 'org)
 (require 'htmlize)
 
+(setq org-safe-remote-resources '("https://solverstack.gitlabpages.inria.fr/inria-org-html-themes/online-theme-readtheorginria.setup"))
+
 (setq org-html-htmlize-output-type 'css)
 (setq org-src-fontify-natively t)
 (org-babel-do-load-languages

tools/pages.sh

@@ -5,13 +5,21 @@
 # @copyright 2020-2024 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
 #                      Univ. Bordeaux. All rights reserved.
 #
-# @version 1.2.0
+# @version 1.3.0
 # @author Florent Pruvost
 # @date 2022-02-22
 #
+set -e
+set -x
 CHAMELEON_SRC_DIR=${CHAMELEON_SRC_DIR:-$PWD}
 
-mkdir tmp_fig
+# where is installed starpu in the docker image
+CURRENTUSER=`whoami`
+if [[ -f /.dockerenv && $CURRENTUSER == "gitlab" ]]; then
+  export PKG_CONFIG_PATH=/home/gitlab/install/starpu/lib/pkgconfig:$PKG_CONFIG_PATH
+fi
+
+mkdir -p tmp_fig
 cd tmp_fig
 
 ## need to generate figures from last benchmarks
@@ -49,22 +57,23 @@ cd ..
 
 ## Build the doc
 VERSION=${VERSION:-pages}
-mkdir -p build-$VERSION
-cd build-$VERSION
-
-cmake $CHAMELEON_SRC_DIR -DCHAMELEON_ENABLE_DOC=ON
-make doc -j5
+cmake -S ${CHAMELEON_SRC_DIR} -B build-$VERSION -DCHAMELEON_ENABLE_DOC=ON
+cmake --build build-$VERSION --target doc --verbose -j5
 
 ## Copy files in public/ used as an artefact (zip archive) to upload on gitlab pages, see
-## Homepage: https://solverstack.gitlabpages.inria.fr/chameleon/index.html
-## API: https://solverstack.gitlabpages.inria.fr/chameleon/dev/index.html
-cd ..
-mkdir public/
-mkdir public/dev/
+mkdir -p public/dev/
+
+## Homepage (user's guide): https://solverstack.gitlabpages.inria.fr/chameleon/index.html
 cp build-$VERSION/doc/user/*.html public/
 cp build-$VERSION/doc/user/*.png public/
 cp build-$VERSION/doc/user/*.jpg public/
 cp build-$VERSION/doc/user/*.svg public/
+
+## API (doxygen): https://solverstack.gitlabpages.inria.fr/chameleon/dev/index.html
 cp -r build-$VERSION/doc/dev/html/* public/dev/
+
+## Images such as last performances on plafrim
 cp tmp_fig/* public/
+
+## lcov code coverage: https://solverstack.gitlabpages.inria.fr/chameleon/coverage/
 cp -r coverage public/