Trac #28374: MR31: Build documentation artifacts during docker build

Julian Rüth ([https://gitlab.com/saraedum @saraedum]) opened a merge
request at https://gitlab.com/sagemath/sage/merge_requests/31:
----
{{{
#!markdown
The documentation is stored as a GitLab artifact (700MB per build.) We
might get into trouble eventually for storing so much data on GitLab but
I did not see any explicit limits there.

See https://sagemath.gitlab.io/-/dev/sage/-/jobs/276493066/artifacts/htm
l/en/index.html for the documentation generated by this branch.
}}}
[[BR]][[BR]][[BR]]

URL: https://trac.sagemath.org/28374
Reported by: galois
Ticket author(s): Julian Rüth
Reviewer(s): Samuel Lelièvre

Author: Release Manager

.ci/build-docker.sh

@@ -39,6 +39,12 @@ docker_build --target run-time-dependencies --tag run-time-dependencies:$DOCKER_
 docker_build --target build-time-dependencies --tag build-time-dependencies:$DOCKER_TAG .
 docker_build --target make-all --tag make-all:$DOCKER_TAG .
 
+# Copy docs out of the docker image to save them into browseable GitLab artifacts
+container=$(docker create make-all:$DOCKER_TAG)
+docker cp $container:/home/sage/sage/local/share/doc/sage/html html_
+# GitLab's browser does not like symlinks, so we flatten them
+rsync html_/ html/ -a --copy-links
+
 # Build the release image without build artifacts.
 docker_build --target sagemath --tag "$DOCKER_IMAGE_CLI" .
 # Display the layers of this image

.gitlab-ci.yml

@@ -88,9 +88,10 @@ build-from-latest:
     when: always
     paths:
     - gitlab-build-docker.log
+    - html
     expire_in: 1 month
   script:
-    - apk --update add coreutils
+    - apk --update add coreutils rsync
     # The output of the build can get larger than gitlab.com's limit; only
     # print the first 1MB (and the last 80 lines.) GitLab's limit is 4MB,
     # however, the list of all branches and tags that shows up in the initial
@@ -115,6 +116,12 @@ build-from-latest:
 build-from-clean:
   extends:
     - build-from-latest
+  artifacts:
+    when: always
+    paths:
+    - gitlab-build-docker.log
+    - html
+    expire_in: 99 years
   variables:
     ARTIFACT_BASE: "source-clean"
   only:
@@ -136,18 +143,21 @@ build-from-clean:
 
 test-dev:
   stage: test
+  dependencies: []
   script:
     - . .ci/pull-gitlab.sh sagemath-dev
     - sh .ci/test-dev.sh "$DOCKER_IMAGE"
 
 test-cli:
   stage: test
+  dependencies: []
   script:
     - . .ci/pull-gitlab.sh sagemath
     - sh .ci/test-cli.sh "$DOCKER_IMAGE"
 
 test-jupyter:
   stage: test
+  dependencies: []
   script:
     - . .ci/pull-gitlab.sh sagemath
     - sh .ci/test-jupyter.sh "$DOCKER_IMAGE" docker
@@ -156,6 +166,7 @@ test-jupyter:
 # variables DOCKER_USER and SECRET_DOCKER_PASS have been set up.
 push-dockerhub:
   stage: release
+  dependencies: []
   only:
     refs:
       - branches
@@ -170,6 +181,7 @@ push-dockerhub:
 # variables DOCKER_USER and SECRET_DOCKER_PASS have been set up.
 push-dockerhub-dev:
   stage: release
+  dependencies: []
   only:
     refs:
       - master