CI Build: Build a docker image incrementally, then test, docbuild, ... in separate jobs

.ci/retrofit-worktree.sh

@@ -0,0 +1,39 @@
+#!/bin/sh
+if [ $# != 2 ]; then
+    echo >&2 "usage: $0 WORKTREE_NAME WORKTREE_DIRECTORY"
+    echo >&2 "Ensures that the current working directory is a git repository,"
+    echo >&2 "then makes WORKTREE_DIRECTORY a git worktree named WORKTREE_NAME."
+fi
+WORKTREE_NAME="$1"
+WORKTREE_DIRECTORY="$2"
+
+export GIT_AUTHOR_NAME="ci-sage workflow"
+export GIT_AUTHOR_EMAIL="ci-sage@example.com"
+export GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
+export GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
+
+set -ex
+
+# If actions/checkout downloaded our source tree using the GitHub REST API
+# instead of with git (because do not have git installed in our image),
+# we first make the source tree a repo.
+if [ ! -d .git ]; then git init && git add -A && git commit --quiet -m "new"; fi
+
+# Tag this state of the source tree "new". This is what we want to build and test.
+git tag -f new
+
+# Our container image contains a source tree in $WORKTREE_DIRECTORY with a full build of Sage.
+# But $WORKTREE_DIRECTORY is not a git repository.
+# We make $WORKTREE_DIRECTORY a worktree whose index is at tag "new".
+# We then commit the current sources and set the tag "old". (This keeps all mtimes unchanged.)
+# Then we update worktree and index with "git reset --hard new".
+# (This keeps mtimes of unchanged files unchanged and mtimes of changed files newer than unchanged files.)
+# Finally we reset the index to "old". (This keeps all mtimes unchanged.)
+# The changed files now show up as uncommitted changes.
+# The final "git add -N" makes sure that files that were added in "new" do not show
+# as untracked files, which would be removed by "git clean -fx".
+git worktree add --detach $WORKTREE_NAME
+rm -rf $WORKTREE_DIRECTORY/.git && mv $WORKTREE_NAME/.git $WORKTREE_DIRECTORY/
+rm -rf $WORKTREE_NAME && ln -s $WORKTREE_DIRECTORY $WORKTREE_NAME
+if [ ! -f $WORKTREE_NAME/.gitignore ]; then cp .gitignore $WORKTREE_NAME/; fi
+(cd $WORKTREE_NAME && git add -A && git commit --quiet --allow-empty -m "old" -a && git tag -f old && git reset --hard new && git reset --quiet old && git add -N . && git status)

.github/workflows/build.yml

@@ -15,7 +15,11 @@ on:
       platform:
         description: 'Platform'
         required: true
-        default: 'ubuntu-focal-standard'
+        default: 'ubuntu-focal'
+      packages:
+        description: 'Platform'
+        required: true
+        default: 'standard'
       docker_tag:
         description: 'Docker tag'
         required: true
@@ -27,171 +31,66 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  get_ci_fixes:
+  changed_files:
     runs-on: ubuntu-latest
+    name: List changed packages
+    outputs:
+      uninstall_targets: ${{ steps.build-targets.outputs.uninstall_targets }}
+      build_targets:     ${{ steps.build-targets.outputs.build_targets }}
     steps:
-      - name: Checkout
-        id: checkout
-        uses: actions/checkout@v4
-      - name: Merge CI fixes from sagemath/sage
-        run: |
-          .ci/merge-fixes.sh
-        env:
-          GH_TOKEN: ${{ github.token }}
-      - name: Store CI fixes in upstream artifact
-        run: |
-          mkdir -p upstream
-          if git format-patch --stdout test_base > ci_fixes.patch; then
-            cp ci_fixes.patch upstream/
-          fi
-      - uses: actions/upload-artifact@v3
+      - uses: actions/checkout@v4
+      - name: Get all packages that have changed
+        id: changed-packages
+        uses: tj-actions/changed-files@v38
         with:
-          path: upstream
-          name: upstream
+          files_yaml: |
+            configures:
+              - 'build/pkgs/*/spkg-configure.m4'
+            pkgs:
+              - 'build/pkgs/**'
+              - 'pkgs/**'
+      - name: Determine targets to build
+        id: build-targets
+        run: |
+          echo "uninstall_targets=$(echo $(for a in '' ${{ steps.changed-packages.outputs.configures_all_changed_files }}; do echo $a | sed -E 's,build/pkgs/([_.a-z0-9]*)/spkg-configure[.]m4 *,\1-uninstall,'; done | sort -u))" >> $GITHUB_OUTPUT
+          echo "build_targets=$(echo $(for a in '' ${{ steps.changed-packages.outputs.pkgs_all_changed_files }}; do echo $a | sed -E 's,-,_,g;s,(build/)?pkgs/([-_.a-z0-9]*)/[^ ]* *,\2-ensure,;'; done | sort -u))" >> $GITHUB_OUTPUT
+          cat $GITHUB_OUTPUT
 
   build:
+    uses: ./.github/workflows/docker.yml
+    with:
+      # Build incrementally from published Docker image
+      incremental: true
+      free_disk_space: true
+      from_docker_repository: ghcr.io/sagemath/sage/
+      from_docker_target: "with-targets"
+      from_docker_tag: "dev"
+      docker_targets: "with-targets"
+      targets: "SAGE_CHECK=no build pypi-wheels"
+      tox_system_factors: >-
+        ["${{ github.event.inputs.platform || 'ubuntu-focal' }}"]
+      tox_packages_factors: >-
+          ["${{ github.event.inputs.packages || 'standard' }}"]
+      image_artifact: image
+
+  test-modularized:
     runs-on: ubuntu-latest
-    container: ghcr.io/sagemath/sage/sage-${{ github.event.inputs.platform || 'ubuntu-focal-standard' }}-with-targets:${{ github.event.inputs.docker_tag || 'dev'}}
-    needs: [get_ci_fixes]
+    container: ghcr.io/${{ github.repository }}/sage-${{ github.event.inputs.platform || 'ubuntu-focal' }}-${{ github.event.inputs.packages || 'packages' }}-with-targets:${{ github.sha }}
+    needs: [build]
+    strategy:
+      fail-fast: false
+      matrix:
+        distribution: ${{ fromJson('["sagemath_repl", "sagemath_categories"]') }}
+    env:
+      IMAGE_ARTIFACT_NAME: image-commit-${{ github.sha }}-tox-docker-ubuntu-focal-standard
     steps:
-      - name: Checkout
-        id: checkout
-        uses: actions/checkout@v4
-
-      - name: Update system packages
-        id: prepare
-        run: |
-          export PATH="build/bin:$PATH"
-          eval $(sage-print-system-package-command auto update)
-          eval $(sage-print-system-package-command auto --spkg --yes --no-install-recommends install git)
-
-      - name: Add prebuilt tree as a worktree
-        id: worktree
-        run: |
-          set -ex
-          git config --global user.email "ci-sage@example.com"
-          git config --global user.name "Build & Test workflow"
-          git config --global --add safe.directory $(pwd)
-          # If actions/checkout downloaded our source tree using the GitHub REST API
-          # instead of with git (because do not have git installed in our image),
-          # we first make the source tree a repo.
-          if [ ! -d .git ]; then git init && git add -A && git commit --quiet -m "new"; fi
-          # Tag this state of the source tree "new". This is what we want to build and test.
-          git tag -f new
-          # Our container image contains a source tree in /sage with a full build of Sage.
-          # But /sage is not a git repository.
-          # We make /sage a worktree whose index is at tag "new".
-          # We then commit the current sources and set the tag "old". (This keeps all mtimes unchanged.)
-          # Then we update worktree and index with "git reset --hard new".
-          # (This keeps mtimes of unchanged files unchanged and mtimes of changed files newer than unchanged files.)
-          # Finally we reset the index to "old". (This keeps all mtimes unchanged.)
-          # The changed files now show up as uncommitted changes.
-          # The final "git add -N" makes sure that files that were added in "new" do not show
-          # as untracked files, which would be removed by "git clean -fx".
-          git worktree add --detach worktree-image
-          rm -rf /sage/.git && mv worktree-image/.git /sage/
-          rm -rf worktree-image && ln -s /sage worktree-image
-          if [ ! -f worktree-image/.gitignore ]; then cp .gitignore worktree-image/; fi
-          (cd worktree-image && git add -A && git commit --quiet --allow-empty -m "old" -a && git tag -f old && git reset --hard new && git reset --quiet old && git add -N . && git status)
-
-      - name: Download upstream artifact
+      - name: Download incremental tar archive artifact
         uses: actions/download-artifact@v3
         with:
-          path: upstream
-          name: upstream
-
-      - name: Apply CI fixes from sagemath/sage
-        # After applying the fixes, make sure all changes are marked as uncommitted changes.
+          name: ${{ env.IMAGE_ARTIFACT_NAME }}
+      - name: Update from incremental tar archive
         run: |
-          if [ -r upstream/ci_fixes.patch ]; then
-            (cd worktree-image && git commit -q -m "current changes" --allow-empty -a && git am; git reset --quiet old; git add -N .) < upstream/ci_fixes.patch
-          fi
-
-      - name: Incremental build, test changed files (sage -t --new)
-        id: incremental
+          (cd / && tar xf -) < *-incremental.tar
+      - name: Test
         run: |
-          # Now re-bootstrap and build. The build is incremental because we were careful with the timestamps.
-          # We run tests with "sage -t --new"; this only tests the uncommitted changes.
-          ./bootstrap && make build && ./sage -t --new -p2
-        working-directory: ./worktree-image
-        env:
-          MAKE: make -j2 --output-sync=recurse
-          SAGE_NUM_THREADS: 2
-
-      - name: Build and test modularized distributions
-        if: always() && steps.worktree.outcome == 'success'
-        run: make V=0 tox && make pypi-wheels
-        working-directory: ./worktree-image
-        env:
-          MAKE: make -j2 --output-sync=recurse
-          SAGE_NUM_THREADS: 2
-
-      - name: Set up node to install pyright
-        if: always() && steps.worktree.outcome == 'success'
-        uses: actions/setup-node@v3
-        with:
-          node-version: '12'
-
-      - name: Install pyright
-        if: always() && steps.worktree.outcome == 'success'
-        # Fix to v232 due to bug https://github.com/microsoft/pyright/issues/3239
-        run: npm install -g pyright@1.1.232
-
-      - name: Static code check with pyright
-        if: always() && steps.worktree.outcome == 'success'
-        run: pyright
-        working-directory: ./worktree-image
-
-      - name: Clean (fallback to non-incremental)
-        id: clean
-        if: always() && steps.worktree.outcome == 'success' && steps.incremental.outcome != 'success'
-        run: |
-          set -ex
-          ./bootstrap && make doc-clean doc-uninstall sagelib-clean && git clean -fx src/sage && ./config.status
-        working-directory: ./worktree-image
-        env:
-          MAKE: make -j2
-          SAGE_NUM_THREADS: 2
-
-      - name: Build
-        # This step is needed because building the modularized distributions installs some optional packages,
-        # so the editable install of sagelib needs to build the corresponding optional extension modules.
-        id: build
-        if: always() && (steps.incremental.outcome == 'success' || steps.clean.outcome == 'success')
-        run: |
-          make build
-        working-directory: ./worktree-image
-        env:
-          MAKE: make -j2 --output-sync=recurse
-          SAGE_NUM_THREADS: 2
-
-      - name: Pytest
-        if: contains(github.ref, 'pytest')
-        run: |
-          ../sage -python -m pip install coverage pytest-xdist
-          ../sage -python -m coverage run -m pytest -c tox.ini --doctest-modules || true
-        working-directory: ./worktree-image/src
-        env:
-          # Increase the length of the lines in the "short summary"
-          COLUMNS: 120
-
-      - name: Test all files (sage -t --all --long)
-        if: always() && steps.build.outcome == 'success'
-        run: |
-          ../sage -python -m pip install coverage
-          ../sage -python -m coverage run ./bin/sage-runtests --all --long -p2 --random-seed=286735480429121101562228604801325644303
-        working-directory: ./worktree-image/src
-
-      - name: Prepare coverage results
-        if: always() && steps.build.outcome == 'success'
-        run: |
-          ./venv/bin/python3 -m coverage combine src/.coverage/
-          ./venv/bin/python3 -m coverage xml
-          find . -name *coverage*
-        working-directory: ./worktree-image
-
-      - name: Upload coverage to codecov
-        if: always() && steps.build.outcome == 'success'
-        uses: codecov/codecov-action@v3
-        with:
-          files: ./worktree-image/coverage.xml
+          make -j2 V=0 tox-ensure && make -j2 ${{ matrix.distribution }}-check"

.github/workflows/ci-conda.yml

@@ -92,7 +92,7 @@ jobs:
         run: |
           # Use --no-deps and pip check below to verify that all necessary dependencies are installed via conda.
           pip install --no-build-isolation --no-deps -v -v -e ./pkgs/sage-conf ./pkgs/sage-setup
-          pip install --no-build-isolation --no-deps -v -v -e ./src
+          pip install --no-build-isolation --no-deps --config-settings editable_mode=compat -v -v -e ./src
         env:
           SAGE_NUM_THREADS: 2