Merge branch 'main' into feat/ota-opc-ci

2026-09-16 21:42:43 +00:00 · 2026-09-15 15:19:43 +08:00
parent ffb2946b20 0956b4d8fe
commit 173706750d
224 changed files with 4402 additions and 1827 deletions
@@ -100,7 +100,7 @@ jobs:
      matrix:
        include: ${{ fromJSON(vars.SELF_HOSTED
          && '[{"arch":"x64","os":"orca-win-server","compiler":"clang"}]'
-          || '[{"arch":"x64","os":"windows-latest","compiler":"clang"},{"arch":"arm64","os":"windows-11-arm","compiler":"clang"}]') }}
+          || '[{"arch":"x64","os":"windows-latest","compiler":"clang"},{"arch":"arm64","os":"windows-11-vs2026-arm","compiler":"clang"}]') }}
    needs: check_build_script
    # Don't run scheduled builds on forks:
    if: ${{ !cancelled() && needs.check_build_script.result == 'success' && (github.event_name != 'schedule' || github.repository == 'OrcaSlicer/OrcaSlicer') }}
@@ -169,7 +169,7 @@ jobs:
    if: ${{ !cancelled() && success() && !vars.SELF_HOSTED }}
    uses: ./.github/workflows/unit_tests.yml
    with:
-      os: windows-11-arm
+      os: windows-11-vs2026-arm
      artifact: ${{ github.sha }}-tests-windows-arm64
      test-dir: build-arm64/tests
  unit_tests_macos_arm64:
@@ -283,21 +283,42 @@ jobs:
      id: fp_cache_key
      run: echo "key=flatpak-builder-${{ matrix.variant.arch }}-${{ hashFiles('deps/**', 'scripts/flatpak/com.orcaslicer.OrcaSlicer.yml', 'scripts/flatpak/make_deps_tar.sh') }}" >> "$GITHUB_OUTPUT"
      shell: bash
-    # Manage flatpak-builder cache externally so PRs restore but never upload
+    # Manage flatpak-builder cache externally so PRs restore but never upload.
+    # The compiler cache under it is keyed per run below, so it is left out.
    - name: Restore flatpak-builder cache
      if: github.event_name == 'pull_request'
      uses: actions/cache/restore@v6
      with:
-        path: .flatpak-builder
+        path: |
+          .flatpak-builder/*
+          !.flatpak-builder/ccache
        key: ${{ steps.fp_cache_key.outputs.key }}
        restore-keys: flatpak-builder-${{ matrix.variant.arch }}-
    - name: Save/restore flatpak-builder cache
      if: github.event_name != 'pull_request'
      uses: actions/cache@v6
      with:
-        path: .flatpak-builder
+        path: |
+          .flatpak-builder/*
+          !.flatpak-builder/ccache
        key: ${{ steps.fp_cache_key.outputs.key }}
        restore-keys: flatpak-builder-${{ matrix.variant.arch }}-
+    # Compiler cache for the OrcaSlicer module, as in build_orca.yml. Pull
+    # requests only restore it; every other run (main, release branches, the
+    # nightly, a dispatch) saves it. orca_deps stays on the state cache above.
+    - name: Name the compiler cache leg
+      run: |
+        leg="Flatpak-${{ matrix.variant.arch }}"
+        echo "CCACHE_LEG=$leg" >> "$GITHUB_ENV"
+        echo "CCACHE_ENTRY=ccache-$leg-${{ github.run_id }}-${{ github.run_attempt }}" >> "$GITHUB_ENV"
+      shell: bash
+    - name: Restore compiler cache
+      id: ccache_restore
+      uses: actions/cache/restore@v6
+      with:
+        path: .flatpak-builder/ccache
+        key: ${{ env.CCACHE_ENTRY }}
+        restore-keys: ccache-${{ env.CCACHE_LEG }}-
    - name: Disable debug info for faster CI builds
      run: |
        sed -i '/^build-options:/a\  no-debuginfo: true\n  strip: true' \
@@ -308,6 +329,33 @@ jobs:
        sed -i "/name: OrcaSlicer/{n;s|buildsystem: simple|buildsystem: simple\n    build-options:\n      env:\n        git_commit_hash: \"$git_commit_hash\"|}" \
          scripts/flatpak/com.orcaslicer.OrcaSlicer.yml
      shell: bash
+    # flatpak-builder's --ccache only wraps cc and gcc, and the manifest builds
+    # with clang, so CMake's launcher runs ccache instead; --ccache is still what
+    # mounts the cache directory into the sandbox. The settings go into that
+    # directory's own config file, which the sandbox reads too.
+    - name: Enable compiler cache
+      run: |
+        printf '        %s\n' \
+          'CMAKE_C_COMPILER_LAUNCHER: ccache' \
+          'CMAKE_CXX_COMPILER_LAUNCHER: ccache' > "$RUNNER_TEMP/ccache-env.yml"
+        sed -i "/^        git_commit_hash: /r $RUNNER_TEMP/ccache-env.yml" \
+          scripts/flatpak/com.orcaslicer.OrcaSlicer.yml
+        grep -q '^        CMAKE_CXX_COMPILER_LAUNCHER: ccache$' scripts/flatpak/com.orcaslicer.OrcaSlicer.yml
+        mkdir -p .flatpak-builder/ccache
+        export CCACHE_DIR=$PWD/.flatpak-builder/ccache
+        ccache --set-config=max_size=3G
+        # The compiler is reinstalled every run, so its mtime means nothing.
+        ccache --set-config=compiler_check=content
+        # Headers a fresh checkout has just written, the few files that use
+        # __DATE__ or __TIME__, and the precompiled header, whose macros ccache
+        # cannot see.
+        ccache --set-config=sloppiness=pch_defines,time_macros,include_file_mtime,include_file_ctime
+        # Hash the includes the compiler reports instead of preprocessing every
+        # miss before compiling it.
+        ccache --set-config=depend_mode=true
+        # The restored directory carries the previous run's counters.
+        ccache -z
+      shell: bash
    - name: Check the manifest keeps orca_deps cacheable
      run: ./scripts/flatpak/check_manifest_cacheable.sh
      shell: bash
@@ -318,9 +366,50 @@ jobs:
      with:
        bundle: OrcaSlicer-Linux-flatpak_${{ env.ver }}_${{ matrix.variant.arch }}.flatpak
        manifest-path: scripts/flatpak/com.orcaslicer.OrcaSlicer.yml
-        cache: false
+        # cache only turns on flatpak-builder --ccache; the caching itself is above.
+        cache: true
+        restore-cache: false
+        save-cache: false
        arch: ${{ matrix.variant.arch }}
        upload-artifact: false
+    # The build has just touched everything it can use, so an object untouched
+    # for a week is dead, usually orphaned by a flag change.
+    - name: Compiler cache statistics
+      if: always()
+      run: |
+        export CCACHE_DIR=$PWD/.flatpak-builder/ccache
+        ccache --evict-older-than 7d
+        ccache -s -v || ccache -s
+      shell: bash
+    # Save the new entry first, then drop the older ones for this leg on this
+    # ref, so a failed save leaves the previous entry in place. A cancelled or
+    # failed build saves too, since what it compiled is still valid; a restore
+    # that did not finish does not, since the directory may be a truncated copy.
+    - name: Save compiler cache
+      id: ccache_save
+      if: ${{ always() && steps.ccache_restore.outcome == 'success' && github.event_name != 'pull_request' }}
+      uses: actions/cache/save@v6
+      with:
+        path: .flatpak-builder/ccache
+        key: ${{ env.CCACHE_ENTRY }}
+    - name: Drop older compiler cache entries
+      if: ${{ always() && steps.ccache_save.outcome == 'success' }}
+      # The container has no gh, so this is the list and delete over the REST API.
+      # Older means a lower run id, so two runs finishing close together keep
+      # the newer entry whichever of them cleans up last.
+      continue-on-error: true
+      env:
+        GH_TOKEN: ${{ github.token }}
+      run: |
+        api="$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/actions/caches"
+        curl -sSf -H "Authorization: Bearer $GH_TOKEN" \
+          "$api?ref=$GITHUB_REF&key=ccache-$CCACHE_LEG-&per_page=100" \
+          | jq -r --arg prefix "ccache-$CCACHE_LEG-" --argjson run "$GITHUB_RUN_ID" \
+              '.actions_caches[] | select((.key | ltrimstr($prefix) | split("-")[0] | tonumber?) < $run) | .id' \
+          | while read -r id; do
+              curl -sSf -X DELETE -H "Authorization: Bearer $GH_TOKEN" "$api/$id"
+            done
+      shell: bash
    - name: Upload artifacts Flatpak
      uses: actions/upload-artifact@v7
      with:
@@ -76,6 +76,60 @@ jobs:
          if (-not (Test-Path "$cmakeBin\cmake.exe")) { throw "cmake.exe not found at $cmakeBin" }
          Add-Content -Path $env:GITHUB_PATH -Value $cmakeBin

+      # Compiler cache. Pushes save it, so main keeps it warm; pull requests
+      # restore it and discard what they compiled. Objects are keyed on the
+      # preprocessed source, the compiler and the flags, so a leg only ever
+      # hits its own entries. A failed install costs the caching, not the build.
+      - name: Name the compiler cache leg
+        if: ${{ !inputs.macos-combine-only }}
+        shell: bash
+        run: |
+          leg="${{ runner.os }}-${{ inputs.arch || 'amd64' }}${{ runner.os == 'Windows' && format('-{0}', inputs.compiler) || '' }}"
+          echo "CCACHE_LEG=$leg" >> "$GITHUB_ENV"
+          echo "CCACHE_ENTRY=ccache-$leg-${{ github.run_id }}-${{ github.run_attempt }}" >> "$GITHUB_ENV"
+
+      # The action only installs and configures ccache. Restore and save go
+      # through actions/cache with one path string, since the cache service
+      # only matches entries saved under the identical path and the action
+      # spells it differently on Windows.
+      - name: Compiler cache
+        id: ccache
+        if: ${{ !inputs.macos-combine-only }}
+        continue-on-error: true
+        uses: hendrikmuhs/ccache-action@v1.2.24
+        with:
+          key: ${{ env.CCACHE_LEG }}
+          max-size: 3G
+          restore: false
+          save: false
+          # ccache -s runs as its own step; no summary table per job.
+          job-summary: ''
+
+      - name: Restore compiler cache
+        id: ccache_restore
+        if: ${{ steps.ccache.outcome == 'success' }}
+        uses: actions/cache/restore@v6
+        with:
+          path: ${{ github.workspace }}/.ccache
+          key: ${{ env.CCACHE_ENTRY }}
+          restore-keys: ccache-${{ env.CCACHE_LEG }}-
+
+      - name: Enable compiler cache
+        if: ${{ steps.ccache.outcome == 'success' }}
+        shell: bash
+        run: |
+          echo "CMAKE_C_COMPILER_LAUNCHER=ccache" >> "$GITHUB_ENV"
+          echo "CMAKE_CXX_COMPILER_LAUNCHER=ccache" >> "$GITHUB_ENV"
+          # Headers a fresh checkout has just written, the few files that
+          # use __DATE__ or __TIME__, and the precompiled header, whose
+          # macros ccache cannot see.
+          echo "CCACHE_SLOPPINESS=pch_defines,time_macros,include_file_mtime,include_file_ctime" >> "$GITHUB_ENV"
+          # Hash the includes the compiler reports instead of preprocessing
+          # every miss before compiling it.
+          echo "CCACHE_DEPEND=1" >> "$GITHUB_ENV"
+          # The restored directory carries the previous run's counters.
+          ccache -z
+
      - name: Get the version and date on Ubuntu and macOS
        if: runner.os != 'Windows'
        run: |
@@ -693,3 +747,41 @@ jobs:
          asset_name: orca_custom_preset_tests.zip
          asset_content_type: application/octet-stream
          max_releases: 1
+
+      # The build has just touched everything it can use, so an object
+      # untouched for a week is dead, usually orphaned by a flag change.
+      - name: Compiler cache statistics
+        if: ${{ always() && steps.ccache.outcome == 'success' }}
+        shell: bash
+        run: |
+          ccache --evict-older-than 7d
+          ccache -s -v || ccache -s
+
+      # Entries are immutable, so the new one is saved first and the older
+      # ones for this leg on this ref are dropped afterwards: a failed save
+      # leaves the previous entry in place. A cancelled or failed build saves
+      # too, since what it compiled is still valid; a restore that did not
+      # finish does not, since the directory may be a truncated copy.
+      - name: Save compiler cache
+        id: ccache_save
+        if: ${{ always() && steps.ccache_restore.outcome == 'success' && github.event_name != 'pull_request' }}
+        uses: actions/cache/save@v6
+        with:
+          path: ${{ github.workspace }}/.ccache
+          key: ${{ env.CCACHE_ENTRY }}
+
+      - name: Drop older compiler cache entries
+        if: ${{ always() && steps.ccache_save.outcome == 'success' }}
+        # A read-only token (fork PRs) cannot delete; that only costs storage.
+        # Older means a lower run id, so two runs finishing close together keep
+        # the newer entry whichever of them cleans up last.
+        continue-on-error: true
+        shell: bash
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh cache list --ref "$GITHUB_REF" --key "ccache-$CCACHE_LEG-" --limit 100 --json id,key \
+            | jq -r --arg prefix "ccache-$CCACHE_LEG-" --argjson run "$GITHUB_RUN_ID" \
+                '.[] | select((.key | ltrimstr($prefix) | split("-")[0] | tonumber?) < $run) | .id' \
+            | tr -d '\r' \
+            | while read -r id; do gh cache delete "$id"; done
@@ -19,11 +19,18 @@ jobs:
    permissions:
      contents: read
    steps:
-      - uses: thejerrybao/setup-swap-space@v1
-        with:
-          swap-space-path: /swapfile
-          swap-size-gb: 8
-          remove-existing-swap-files: true
+      # Doxygen with call graphs over all of src/ outgrows the runner's RAM;
+      # replace the runner's swapfile with an 8 GB one.
+      - name: Grow swap space
+        run: |
+          set -euo pipefail
+          sudo swapoff -a
+          sudo rm -f /swapfile
+          sudo fallocate -l 8G /swapfile
+          sudo chmod 600 /swapfile
+          sudo mkswap /swapfile
+          sudo swapon /swapfile
+          free -h

      - name: Checkout repository
        uses: actions/checkout@v7
@@ -0,0 +1,219 @@
+# Nightly parity checks from OrcaSlicer/orca-test-repo, kept out of the
+# per-build "Run external slicer regression tests" step because they take far
+# longer than that step's budget:
+#   effect  - the CLI override sweep's full effect stage: every landed option
+#             re-sliced on its own to see whether it changes the G-code
+#   harness - the GUI-vs-CLI parity harness (metrics only, never fails)
+# Both test the latest successful build_all.yml Linux AppImage from main, with
+# sources checked out at the commit that build was made from. Nothing here
+# gates a build or a PR.
+name: Parity Nightly
+
+on:
+  schedule:
+    # build_all.yml starts at 17:00 UTC and has finished by ~20:00
+    - cron: "0 21 * * *"
+  workflow_dispatch:
+    inputs:
+      test_repo_ref:
+        description: "orca-test-repo ref to run"
+        required: false
+        default: "main"
+      build_branch:
+        description: "branch whose latest successful build_all artifact to test"
+        required: false
+        default: "main"
+      fixtures:
+        description: "harness fixture ids, space-separated (empty = all)"
+        required: false
+        default: ""
+      cli_presets:
+        description: "harness lane C presets: flat = flatten inherits first, raw = leaf profile as-is"
+        required: false
+        default: "flat"
+
+permissions:
+  contents: read
+  actions: read
+
+jobs:
+  build:
+    name: Find the build to test
+    # Don't run scheduled checks on forks
+    if: github.event_name != 'schedule' || github.repository == 'OrcaSlicer/OrcaSlicer'
+    runs-on: ubuntu-24.04
+    outputs:
+      run_id: ${{ steps.find.outputs.run_id }}
+      head_sha: ${{ steps.find.outputs.head_sha }}
+    steps:
+      - id: find
+        env:
+          GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+        run: |
+          set -euo pipefail
+          gh run list --workflow build_all.yml \
+            --branch "${{ inputs.build_branch || 'main' }}" \
+            --status success --limit 1 --json databaseId,headSha \
+            --jq '"run_id=\(.[0].databaseId)\nhead_sha=\(.[0].headSha)"' \
+            >> "$GITHUB_OUTPUT"
+          cat "$GITHUB_OUTPUT"
+
+  effect:
+    name: Override sweep effect stage (shard ${{ matrix.shard }})
+    needs: build
+    runs-on: ubuntu-24.04
+    timeout-minutes: 60
+    strategy:
+      fail-fast: false
+      matrix:
+        # orca-test-repo's parity/effect_routing.json holds a 2-way split,
+        # ~12.5 min a shard on this runner
+        shard: [0, 1]
+    steps:
+      - &checkout-suite
+        name: Check out the test suite
+        uses: actions/checkout@v7
+        with:
+          repository: OrcaSlicer/orca-test-repo
+          ref: ${{ inputs.test_repo_ref || 'main' }}
+          path: orca-test-repo
+
+      # The AppImage ships only packed preset caches, so profiles and the CLI
+      # option surface come from the sources the build was made from
+      - &checkout-slicer
+        name: Check out OrcaSlicer at the build's commit
+        uses: actions/checkout@v7
+        with:
+          ref: ${{ needs.build.outputs.head_sha }}
+          path: slicer
+          lfs: 'false'
+
+      - &extract-appimage
+        name: Download and extract the Linux AppImage
+        env:
+          GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+        run: |
+          set -euo pipefail
+          gh run download "${{ needs.build.outputs.run_id }}" --dir appimage \
+            --pattern "OrcaSlicer_Linux_ubuntu_2404*"
+          appimage=$(find appimage -name "*.AppImage" ! -name "*aarch64*" | head -1)
+          [ -n "$appimage" ] || { echo "no x86_64 AppImage in run ${{ needs.build.outputs.run_id }}"; exit 1; }
+          chmod +x "$appimage"
+          "$appimage" --appimage-extract > /dev/null
+          # The bare binary cannot find the AppImage's bundled libraries; AppRun
+          # sets them up and execs it, so exit codes and signals pass through
+          [ -x squashfs-root/AppRun ] || { echo "no AppRun in the AppImage"; exit 1; }
+          echo "ORCA_BIN=$PWD/squashfs-root/AppRun" >> "$GITHUB_ENV"
+          echo "ORCA_SOURCE=$PWD/slicer" >> "$GITHUB_ENV"
+
+      - name: Install the AppImage's host runtime dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends \
+            libopengl0 libglu1-mesa libgl1 libegl1 libwebkit2gtk-4.1-0
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install suite dependencies
+        run: pip install -r orca-test-repo/requirements.txt
+
+      - name: Run the override sweep with the full effect stage
+        id: run
+        continue-on-error: true
+        working-directory: orca-test-repo
+        run: |
+          set -o pipefail
+          # -rA keeps the per-stage summaries, which pytest otherwise swallows
+          # for passing tests
+          python -m pytest test_cli_overrides.py -c pytest.ini -v -rA \
+            --effect-full --effect-shard ${{ matrix.shard }}/2 \
+            --orca-bin "$ORCA_BIN" --orca-source "$ORCA_SOURCE" \
+            2>&1 | tee ../sweep.log
+
+      - name: Publish job summary
+        if: always()
+        run: |
+          {
+            echo "## Override sweep effect stage, shard ${{ matrix.shard }}/2"
+            echo "Build ${{ needs.build.outputs.head_sha }} (run ${{ needs.build.outputs.run_id }})"
+            echo '```'
+            grep -E "\[override sweep" sweep.log || echo "no stage summaries, see the log"
+            grep -E "^=+ .*(passed|failed)" sweep.log | tail -1 || true
+            echo '```'
+          } >> "$GITHUB_STEP_SUMMARY"
+
+      - name: Upload the override report
+        if: always()
+        uses: actions/upload-artifact@v7
+        with:
+          name: override-report-shard${{ matrix.shard }}
+          path: |
+            orca-test-repo/.pytest_cache/override_report.json
+            sweep.log
+          if-no-files-found: warn
+          retention-days: 30
+
+      # The sweep step continues on error so the summary and report still get
+      # published; this puts the failure back on the job
+      - name: Fail the job if the sweep failed
+        if: steps.run.outcome == 'failure'
+        run: |
+          echo "the override sweep failed, see the job summary and the uploaded report" >&2
+          exit 1
+
+  harness:
+    name: GUI-vs-CLI parity harness
+    needs: build
+    runs-on: ubuntu-24.04
+    timeout-minutes: 180
+    steps:
+      - *checkout-suite
+      - *checkout-slicer
+      - *extract-appimage
+
+      - name: Install display tooling and the AppImage's host runtime
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends \
+            xvfb xdotool imagemagick openbox mesa-utils \
+            libopengl0 libglu1-mesa libgl1 libegl1 libwebkit2gtk-4.1-0
+
+      - name: Run the parity harness
+        run: |
+          set -euo pipefail
+          fixtures=()
+          for f in ${{ inputs.fixtures || '' }}; do
+            fixtures+=(--fixture "$f")
+          done
+          # 2 GUI displays: ~1.5 cores peak / ~1.9 GB on this 4-vCPU runner,
+          # and each fixture is fully isolated, so results match a serial run
+          python3 orca-test-repo/parity/run_parity.py \
+            --slicer-root "$ORCA_SOURCE" --bin "$ORCA_BIN" \
+            --cli-presets "${{ inputs.cli_presets || 'flat' }}" \
+            --gui-workers 2 --out "$PWD/parity-out" "${fixtures[@]}"
+
+      - name: Publish job summary
+        if: always()
+        run: |
+          if [ -f parity-out/report.md ]; then
+            cat parity-out/report.md >> "$GITHUB_STEP_SUMMARY"
+          else
+            echo "the harness produced no report, see the log" >> "$GITHUB_STEP_SUMMARY"
+          fi
+
+      - name: Drop per-lane datadirs before upload
+        if: always()
+        run: rm -rf parity-out/*/seed parity-out/*/datadir-* || true
+
+      - name: Upload the scorecard and evidence
+        if: always()
+        uses: actions/upload-artifact@v7
+        with:
+          name: parity-scorecard
+          path: parity-out/
+          if-no-files-found: warn
+          retention-days: 30