Merge pull request #1889 from lightninglabs/wip/speed-ci

GitHub CI: modularize LiT setup, add reusable cleanup action, and adopt matrix builds

Author: ffranr

.github/actions/cleanup-space/action.yaml

@@ -7,26 +7,46 @@ runs:
     - name: Free up disk space
       shell: bash
       run: |
+        set -euo pipefail
+
         echo "Removing large toolsets to free up disk space..."
         echo "Disk space before cleanup:"
-        df -h
-
-        # Remove dotnet to save disk space.
-        sudo rm -rf /usr/share/dotnet
-        # Remove android to save disk space.
-        sudo rm -rf /usr/local/lib/android
-        # Remove ghc to save disk space.
-        sudo rm -rf /opt/ghc
-        # Remove large packages.
-        sudo rm -rf /usr/share/swift
-        sudo rm -rf /usr/local/julia*
-        sudo rm -rf /opt/hostedtoolcache
+        df -h || true
+
+        shopt -s nullglob
+
+        remove_path() {
+          local path="$1"
+          if [ -e "$path" ] || [ -L "$path" ]; then
+            echo "Removing $path"
+            sudo rm -rf "$path"
+          fi
+        }
+
+        # Remove large toolsets and caches.
+        remove_path /usr/share/dotnet
+        remove_path /usr/local/lib/android
+        remove_path /opt/ghc
+        remove_path /usr/share/swift
+        for path in /usr/local/julia*; do remove_path "$path"; done
+        remove_path /opt/hostedtoolcache
+
+        # Remove caches.
+        remove_path /usr/local/share/boost
+        if [ -n "${AGENT_TOOLSDIRECTORY:-}" ]; then
+          remove_path "$AGENT_TOOLSDIRECTORY"
+        fi
 
         # Remove docker images to save space.
-        docker image prune -a -f || true
+        if command -v docker >/dev/null 2>&1; then
+          docker image prune -a -f || true
+        else
+          echo "Docker not available; skipping image prune."
+        fi
 
-        # Remove large apt packages.
-        sudo apt-get remove -y \
+        # Remove large apt packages when available.
+        if command -v apt-get >/dev/null 2>&1; then
+          sudo apt-get remove -y \
             '^aspnetcore-.*' \
             '^dotnet-.*' \
             '^llvm-.*' \
@@ -39,12 +59,11 @@ runs:
             powershell \
             mono-devel \
             libgl1-mesa-dri 2>/dev/null || true
-        sudo apt-get autoremove -y
-        sudo apt-get clean
-
-        # Remove caches.
-        sudo rm -rf /usr/local/share/boost
-        sudo rm -rf "$AGENT_TOOLSDIRECTORY"
+          sudo apt-get autoremove -y || true
+          sudo apt-get clean || true
+        else
+          echo "apt-get not available; skipping package removals."
+        fi
 
         echo "Disk space after cleanup:"
-        df -h
+        df -h || true

.github/actions/lit-setup/action.yml

@@ -0,0 +1,40 @@
+name: LiT setup
+description: Prepare LiT workspace with Taproot-Assets replaces, caches, and dependencies
+runs:
+  using: composite
+  steps:
+    - name: setup go
+      uses: actions/setup-go@v5
+      with:
+        go-version: '~${{ env.GO_VERSION }}'
+        cache: true
+        cache-dependency-path: |
+          lightning-terminal/go.sum
+          go.sum
+
+    - name: Clone LiT repository
+      uses: actions/checkout@v5
+      with:
+        repository: lightninglabs/lightning-terminal
+        ref: ${{ env.LITD_BRANCH }}
+        path: lightning-terminal
+
+    - name: Update go.mod to use the local repository
+      working-directory: ./lightning-terminal
+      run: |
+        go mod edit -replace=github.com/lightninglabs/taproot-assets=../
+        go mod edit -replace=github.com/lightninglabs/taproot-assets/taprpc=../taprpc
+        go mod tidy
+      shell: bash
+
+    - name: Setup Node.js and cache Yarn dependencies
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20.x'
+        cache: 'yarn'
+        cache-dependency-path: lightning-terminal/app/yarn.lock
+
+    - name: Install LiT app dependencies
+      working-directory: ./lightning-terminal/app
+      run: yarn
+      shell: bash

.github/workflows/main.yaml

@@ -16,17 +16,15 @@ defaults:
     shell: bash
 
 env:
-  # go needs absolute directories, using the $HOME variable doesn't work here.
+  # Go needs absolute directories; using the $HOME variable doesn't work here.
   GOPATH: /home/runner/work/go
 
   GO_VERSION: '1.24.9'
-  
-  LITD_ITEST_BRANCH: 'master'
+
+  LITD_BRANCH: 'master'
 
 jobs:
-  #######################
-  # sql model generation
-  #######################
+  # Validate generated SQL models stay in sync with queries.
   sqlc-check:
     name: Sqlc check
     runs-on: ubuntu-latest
@@ -46,6 +44,7 @@ jobs:
       - name: Generate sql models
         run: make sqlc-check
 
+  # Rebuild RPC stubs and REST annotations to detect drift.
   rpc-check:
     name: RPC check
     runs-on: ubuntu-latest
@@ -61,6 +60,7 @@ jobs:
       - name: Generate RPC stubs and check REST annotations
         run: make rpc-check
 
+  # Ensure go.mod and go.sum remain tidy.
   mod-check:
     name: go mod check
     runs-on: ubuntu-latest
@@ -76,6 +76,7 @@ jobs:
       - name: Run go mod tidy
         run: make mod-check
 
+  # Confirm deterministic test vectors are up to date.
   test-vector-check:
     name: test vector check
     runs-on: ubuntu-latest
@@ -91,6 +92,7 @@ jobs:
       - name: Run test vector creation check
         run: make test-vector-check
 
+  # Verify database migration numbering and versions.
   migration-check:
     name: migration version check
     runs-on: ubuntu-latest
@@ -101,9 +103,7 @@ jobs:
       - name: Run migration check
         run: make migration-check
 
-  ########################
-  # Compilation check.
-  ########################
+  # Build the codebase and docs examples to catch compilation regressions.
   compile-check:
     name: Compilation check
     runs-on: ubuntu-latest
@@ -122,9 +122,7 @@ jobs:
       - name: Compile docs examples
         run: make build-docs-examples
 
-  ########################
-  # sample configuration check
-  ########################
+  # Guard sample-tapd.conf defaults against accidental drift.
   sample-conf-check:
     name: sample configuration check
     runs-on: ubuntu-latest
@@ -140,9 +138,7 @@ jobs:
       - name: check default values in sample-tapd.conf file
         run: make sample-conf-check
 
-  ########################
-  # Docker build check.
-  ########################
+  # Smoke test Docker builds for default and dev images.
   docker-build-check:
     name: Docker build check
     runs-on: ubuntu-latest
@@ -167,12 +163,22 @@ jobs:
           file: dev.Dockerfile
           tags: 'dev-taproot-assets'
 
-  ########################
-  # cross compilation
-  ########################
+  # Cross-compile release binaries across supported targets.
   cross-compile:
     name: cross compilation
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        sys:
+          - darwin-amd64
+          - darwin-arm64
+          - linux-386
+          - linux-amd64
+          - linux-armv6
+          - linux-armv7
+          - linux-arm64
+          - windows-amd64
     steps:
       - name: git checkout
         uses: actions/checkout@v5
@@ -185,12 +191,10 @@ jobs:
         with:
           go-version: '${{ env.GO_VERSION }}'
 
-      - name: build release for all architectures
-        run: make release
+      - name: Build release for ${{ matrix.sys }}
+        run: make release sys=${{ matrix.sys }}
 
-  ########################
-  # Lint check.
-  ########################
+  # Run the lint suite for static analysis coverage.
   lint-check:
     name: Lint check
     runs-on: ubuntu-latest
@@ -208,9 +212,7 @@ jobs:
       - name: run lint
         run: make lint
 
-  ########################
-  # Format check.
-  ########################
+  # Enforce formatting consistency.
   format-check:
     name: Format check
     runs-on: ubuntu-latest
@@ -226,9 +228,7 @@ jobs:
       - name: run format
         run: make fmt
 
-  ########################
-  # check PR updates release notes
-  ########################
+  # Ensure pull requests update release notes unless explicitly skipped.
   milestone-check:
     name: Check release notes updated
     runs-on: ubuntu-latest
@@ -240,9 +240,7 @@ jobs:
       - name: Release notes check
         run: scripts/check-release-notes.sh
 
-  ########################
-  # run unit tests
-  ########################
+  # Unit tests with race detection, coverage, and Postgres backend variants.
   unit-test:
     name: run unit tests
     runs-on: ubuntu-latest
@@ -263,7 +261,7 @@ jobs:
         with:
           go-version: '${{ env.GO_VERSION }}'
 
-      - name: run ${{ matrix.unit_type }}
+      - name: Run ${{ matrix.unit_type }}
         run: make ${{ matrix.unit_type }}
 
       - name: Send coverage
@@ -276,9 +274,7 @@ jobs:
           format: 'golang'
           parallel: true
 
-  ########################
-  # run integration tests
-  ########################
+  # Integration tests on SQLite backend.
   integration-test:
     name: run itests
     runs-on: ubuntu-latest
@@ -319,9 +315,7 @@ jobs:
           format: 'golang'
           parallel: true
 
-  ########################
-  # run integration tests with Postgres backend
-  ########################
+  # Integration tests on Postgres backend.
   integration-test-postgres:
     name: run itests postgres
     runs-on: ubuntu-latest
@@ -362,60 +356,32 @@ jobs:
           format: 'golang'
           parallel: true
 
-  ########################
-  # Run LiTd tests
-  ########################
-  run-lit-tests:
-    name: run LiT tests
+  # LiT integration/unit tests with Taproot Assets replacements.
+  run-lit:
+    name: run LiT ${{ matrix.task_name }}
     runs-on: ubuntu-latest
+    continue-on-error: true
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - task_name: itests (custom_channels)
+            run_cmd: make itest icase=custom_channels
+          - task_name: unit
+            run_cmd: make unit
 
     steps:
       - name: git checkout
-        uses: actions/checkout@v5
-
-      - name: Clean up runner space
-        uses: ./.github/actions/cleanup-space
-
-      - name: Setup go ${{ env.GO_VERSION }}
-        uses: actions/setup-go@v5
-        with:
-          go-version: '${{ env.GO_VERSION }}'
-
-      - name: Clone Lit repository
         uses: actions/checkout@v4
-        with:
-          repository: lightninglabs/lightning-terminal
-          ref: ${{ env.LITD_ITEST_BRANCH }}
-          path: lightning-terminal
-
-      - name: Update go.mod to use the local Tap repository
-        working-directory: ./lightning-terminal
-        run: |
-          go mod edit -replace=github.com/lightninglabs/taproot-assets=../
-          go mod edit -replace=github.com/lightninglabs/taproot-assets/taprpc=../taprpc
-          go mod tidy
-
-      - name: Install yarn
-        run: npm install -g yarn
-
-      - name: setup nodejs
-        uses: ./lightning-terminal/.github/actions/setup-node
-        with:
-          node-version: 16.x
-
-      - name: install LiT app dependencies
-        working-directory: ./lightning-terminal/app
-        run: yarn
 
-      - name: Run LiT itests
-        working-directory: ./lightning-terminal
-        run: make itest icase=custom_channels
+      - name: Prepare LiT workspace
+        uses: ./.github/actions/lit-setup
 
-      - name: Run LiT unit tests
+      - name: Run LiT ${{ matrix.task_name }}
         working-directory: ./lightning-terminal
-        run: make unit
+        run: ${{ matrix.run_cmd }}
 
-  # Notify about the completion of all coverage collecting jobs.
+  # Finalize Coveralls reporting after parallel coverage jobs.
   finish:
     if: ${{ always() }}
     needs: [ unit-test ]