linux.yml

name: Linux

on:
  pull_request:
  push:
    branches:
      - dev
      - release

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  go-mod-tidy:
    # Check that go.sum is up to date.
    runs-on: ubuntu-slim
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          submodules: true
      - name: Install Go
        uses: actions/setup-go@v6
        with:
          go-version: '1.27.1'
          cache: true
      - name: Run go mod tidy
        run: go mod tidy
      - name: Check go.mod and go.sum are up to date
        run: git diff --exit-code

  build-linux:
    # Build Linux binaries, ready for release.
    # This runs inside an Alpine Linux container so we can more easily create a
    # statically linked binary.
    runs-on: ubuntu-latest
    container:
      image: golang:1.27-alpine
    outputs:
      version: ${{ steps.version.outputs.version }}
    steps:
      - name: Install apk dependencies
        # tar: needed for actions/cache@v5
        # git+openssh: needed for checkout (I think?)
        # ruby: needed to install fpm
        run: apk add tar git openssh make g++ ruby-dev mold
      - name: Work around CVE-2022-24765
        # We're not on a multi-user machine, so this is safe.
        run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
      - name: Checkout
        uses: actions/checkout@v6
        with:
          submodules: true
      - name: Extract TinyGo version
        id: version
        run: ./.github/workflows/tinygo-extract-version.sh | tee -a "$GITHUB_OUTPUT"
      - name: Cache Go
        uses: actions/cache@v5
        with:
          key: go-cache-linux-alpine-v2-${{ hashFiles('go.mod') }}
          path: |
            ~/.cache/go-build
            ~/go/pkg/mod
      - name: Restore LLVM source cache
        uses: actions/cache/restore@v5
        id: cache-llvm-source
        with:
          key: llvm-source-22-linux-alpine-v1-${{ hashFiles('llvm-version.txt') }}
          path: |
            llvm-project/clang/lib/Headers
            llvm-project/clang/include
            llvm-project/compiler-rt
            llvm-project/lld/include
            llvm-project/llvm/include
      - name: Download LLVM source
        if: steps.cache-llvm-source.outputs.cache-hit != 'true'
        run: make llvm-source
      - name: Save LLVM source cache
        uses: actions/cache/save@v5
        if: steps.cache-llvm-source.outputs.cache-hit != 'true'
        with:
          key: ${{ steps.cache-llvm-source.outputs.cache-primary-key }}
          path: |
            llvm-project/clang/lib/Headers
            llvm-project/clang/include
            llvm-project/compiler-rt
            llvm-project/lld/include
            llvm-project/llvm/include
      - name: Restore LLVM build cache
        uses: actions/cache/restore@v5
        id: cache-llvm-build
        with:
          key: llvm-build-22-linux-alpine-v1-${{ hashFiles('llvm-version.txt') }}
          path: llvm-build
      - name: Build LLVM
        if: steps.cache-llvm-build.outputs.cache-hit != 'true'
        run: |
          # fetch LLVM source
          rm -rf llvm-project
          make llvm-source
          # install dependencies
          apk add cmake samurai python3
          # build!
          make llvm-build
          # Remove unnecessary object files (to reduce cache size).
          find llvm-build -name CMakeFiles -prune -exec rm -r '{}' \;
      - name: Save LLVM build cache
        uses: actions/cache/save@v5
        if: steps.cache-llvm-build.outputs.cache-hit != 'true'
        with:
          key: ${{ steps.cache-llvm-build.outputs.cache-primary-key }}
          path: llvm-build
      - name: Cache Binaryen
        uses: actions/cache@v5
        id: cache-binaryen
        with:
          key: binaryen-linux-alpine-v3
          path: build/wasm-opt
      - name: Build Binaryen
        if: steps.cache-binaryen.outputs.cache-hit != 'true'
        run: |
          apk add cmake samurai python3
          make binaryen STATIC=1
      - name: Install fpm
        run: |
          gem install --version 4.0.7 public_suffix
          gem install --version 2.7.6 dotenv
          gem install --no-document fpm
      - name: Run linter
        run: make lint
      - name: Run spellcheck
        run: make spell
      - name: Build TinyGo release
        run: |
          make release deb -j3 STATIC=1
          cp -p build/release.tar.gz /tmp/tinygo${{ steps.version.outputs.version }}.linux-amd64.tar.gz
          cp -p build/release.deb    /tmp/tinygo_${{ steps.version.outputs.version }}_amd64.deb
      - name: "Publish release artifact: tarball"
        uses: actions/upload-artifact@v7
        with:
          name: tinygo${{ steps.version.outputs.version }}.linux-amd64.tar.gz
          path: /tmp/tinygo${{ steps.version.outputs.version }}.linux-amd64.tar.gz
          archive: false
      - name: "Publish release artifact: Debian package"
        uses: actions/upload-artifact@v7
        with:
          name: tinygo_${{ steps.version.outputs.version }}_amd64.deb
          path: /tmp/tinygo_${{ steps.version.outputs.version }}_amd64.deb
          archive: false
  test-linux-build:
    # Test the binaries built in the build-linux job by running the smoke tests.
    runs-on: ubuntu-latest
    needs: build-linux
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          submodules: true
      - name: Install Go
        uses: actions/setup-go@v6
        with:
          go-version: '1.27.1'
          cache: true
      - name: Install wasmtime
        uses: bytecodealliance/actions/wasmtime/setup@v1
        with:
          version: "29.0.1"
      - name: Install wasm-tools
        uses: bytecodealliance/actions/wasm-tools/setup@v1
      - name: Download release artifact
        uses: actions/download-artifact@v8
        with:
          name: tinygo${{ needs.build-linux.outputs.version }}.linux-amd64.tar.gz
      - name: Extract release tarball
        run: |
          mkdir -p ~/lib
          tar -C ~/lib -xf tinygo${{ needs.build-linux.outputs.version }}.linux-amd64.tar.gz
          ln -s ~/lib/tinygo/bin/tinygo ~/go/bin/tinygo
      - run: make tinygo-test-wasip1-fast
      - run: make tinygo-test-wasip2-fast
      - run: make tinygo-test-wasm
  smoketest-linux:
    # Build a binary for every supported board, using the binaries built in the
    # build-linux job. This is the only job that runs the full smoke test. The
    # result does not depend on the host OS, so the other jobs build a
    # representative board for each architecture with smoketest-quick.
    runs-on: ubuntu-latest
    needs: build-linux
    strategy:
      fail-fast: false
      matrix:
        # Balanced with the measured build time of each group, so that the
        # shards finish at about the same time.
        group:
          - smoketest-rp2xxx smoketest-selftest smoketest-wasm-sim smoketest-py32
          - smoketest-esp smoketest-riscv smoketest-flags
          - smoketest-examples smoketest-nxp smoketest-pwm-usb smoketest-avr
          - smoketest-samd smoketest-stm32 smoketest-nrf smoketest-wasm
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          submodules: true
      - name: Install Go
        uses: actions/setup-go@v6
        with:
          go-version: '1.27.1'
          cache: true
      - name: Download release artifact
        uses: actions/download-artifact@v8
        with:
          name: tinygo${{ needs.build-linux.outputs.version }}.linux-amd64.tar.gz
      - name: Extract release tarball
        run: |
          mkdir -p ~/lib
          tar -C ~/lib -xf tinygo${{ needs.build-linux.outputs.version }}.linux-amd64.tar.gz
          ln -s ~/lib/tinygo/bin/tinygo ~/go/bin/tinygo
      - run: make testchdir ${{ matrix.group }}
  assert-test-linux:
    # Run all tests that can run on Linux, with LLVM assertions enabled to catch
    # potential bugs.
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          submodules: true
      - name: Install apt dependencies
        run: |
          echo "Show cpuinfo; sometimes useful when troubleshooting"
          cat /proc/cpuinfo
          sudo apt-get update
          sudo apt-get install --no-install-recommends \
              libgcrypt20 \
              libpixman-1-0 \
              libsdl2-2.0-0 \
              libslirp0 \
              qemu-system-arm \
              qemu-system-riscv32 \
              qemu-user \
              simavr
      - name: Install Go
        uses: actions/setup-go@v6
        with:
          go-version: '1.27.1'
          cache: true
      - name: Install Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '22'
      - name: Install wasmtime
        uses: bytecodealliance/actions/wasmtime/setup@v1
        with:
          version: "29.0.1"
      - name: Setup `wasm-tools`
        uses: bytecodealliance/actions/wasm-tools/setup@v1
      - name: Install Espressif QEMU
        run: |
          release=esp-develop-9.2.2-20260417
          archive=qemu-xtensa-softmmu-${release//-/_}-x86_64-linux-gnu.tar.xz
          curl -fL --retry 3 -o "$RUNNER_TEMP/$archive" \
            "https://github.com/espressif/qemu/releases/download/$release/$archive"
          tar -xJf "$RUNNER_TEMP/$archive" -C "$RUNNER_TEMP"
          echo "$RUNNER_TEMP/qemu/bin" >> "$GITHUB_PATH"
      - uses: ./.github/actions/setup-llvm
      - name: Cache Binaryen
        uses: actions/cache@v5
        id: cache-binaryen
        with:
          key: binaryen-linux-asserts-v1
          path: build/wasm-opt
      - name: Build Binaryen
        if: steps.cache-binaryen.outputs.cache-hit != 'true'
        run: make binaryen
      - run: make gen-device -j4
      - name: Test TinyGo
        run: make ASSERT=1 test
      - name: Check Go code formatting
        run: make fmt-check lint

  assert-build-linux:
    # Build TinyGo with LLVM assertions enabled and publish it for the jobs
    # below, so that they do not have to build it again. The tarball is not a
    # release file, thus its name does not hold the version.
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          submodules: true
      - name: Install Go
        uses: actions/setup-go@v6
        with:
          go-version: '1.27.1'
          cache: true
      - uses: ./.github/actions/setup-llvm
        with:
          # assert-test-linux saves the cache. This job only reads it, so that
          # the two jobs do not write the same key.
          save-cache: "false"
      - name: Restore Binaryen
        uses: actions/cache/restore@v5
        id: cache-binaryen
        with:
          key: binaryen-linux-asserts-v1
          path: build/wasm-opt
      - name: Build Binaryen
        if: steps.cache-binaryen.outputs.cache-hit != 'true'
        run: make binaryen
      - run: make gen-device -j4
      - name: Build TinyGo release tarball
        run: |
          make release ASSERT=1 -j4
          cp -p build/release.tar.gz /tmp/tinygo-asserts.linux-amd64.tar.gz
      - name: Publish TinyGo build
        uses: actions/upload-artifact@v7
        with:
          name: tinygo-asserts.linux-amd64.tar.gz
          path: /tmp/tinygo-asserts.linux-amd64.tar.gz
          archive: false

  assert-stdlib-test-linux:
    # Test the standard library with the assertions build.
    runs-on: ubuntu-24.04
    needs: assert-build-linux
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          submodules: true
      - name: Install Go
        uses: actions/setup-go@v6
        with:
          go-version: '1.27.1'
          cache: true
      - name: Download TinyGo build
        uses: actions/download-artifact@v8
        with:
          name: tinygo-asserts.linux-amd64.tar.gz
      - name: Extract TinyGo build
        run: |
          mkdir -p ~/lib
          tar -C ~/lib -xf tinygo-asserts.linux-amd64.tar.gz
          ln -s ~/lib/tinygo/bin/tinygo ~/go/bin/tinygo
      - name: Test stdlib packages
        run: make tinygo-test

  assert-smoketest-linux:
    # The smoke test, the wasm tests, and the baremetal tests, with the
    # assertions build.
    runs-on: ubuntu-24.04
    needs: assert-build-linux
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          submodules: true
      - name: Install apt dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --no-install-recommends \
              libgcrypt20 \
              libpixman-1-0 \
              libsdl2-2.0-0 \
              libslirp0 \
              qemu-system-arm \
              qemu-system-riscv32 \
              qemu-user \
              simavr
      - name: Install Go
        uses: actions/setup-go@v6
        with:
          go-version: '1.27.1'
          cache: true
      - name: Install Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '22'
      - name: Install wasmtime
        uses: bytecodealliance/actions/wasmtime/setup@v1
        with:
          version: "29.0.1"
      - name: Setup `wasm-tools`
        uses: bytecodealliance/actions/wasm-tools/setup@v1
      - name: Download TinyGo build
        uses: actions/download-artifact@v8
        with:
          name: tinygo-asserts.linux-amd64.tar.gz
      - name: Extract TinyGo build
        run: |
          mkdir -p ~/lib
          tar -C ~/lib -xf tinygo-asserts.linux-amd64.tar.gz
          ln -s ~/lib/tinygo/bin/tinygo ~/go/bin/tinygo
      - run: make smoketest-quick
      - run: make wasmtest
      - run: make tinygo-test-baremetal
  build-linux-cross:
    # Build ARM Linux binaries, ready for release.
    # This intentionally uses an older Linux image, so that we compile against
    # an older glibc version and therefore are compatible with a wide range of
    # Linux distributions.
    # It is set to "needs: build-linux" because it modifies the release created
    # in that process to avoid doing lots of duplicate work and to avoid
    # complications around precompiled libraries such as compiler-rt shipped as
    # part of the release tarball.
    strategy:
      matrix:
        goarch: [ arm, arm64 ]
        include:
          - goarch: arm64
            toolchain: aarch64-linux-gnu
            libc: arm64
          - goarch: arm
            toolchain: arm-linux-gnueabihf
            libc: armhf
    runs-on: ubuntu-22.04 # note: use the oldest image available! (see above)
    needs: build-linux
    steps:
      - name: Checkout
        uses: actions/checkout@v6
      - name: Get TinyGo version
        id: version
        run: ./.github/workflows/tinygo-extract-version.sh | tee -a "$GITHUB_OUTPUT"
      - name: Install apt dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --no-install-recommends \
              qemu-user \
              g++-${{ matrix.toolchain }} \
              libc6-dev-${{ matrix.libc }}-cross
      - name: Install Go
        uses: actions/setup-go@v6
        with:
          go-version: '1.27.1'
          cache: true
      - name: Restore LLVM source cache
        uses: actions/cache/restore@v5
        id: cache-llvm-source
        with:
          key: llvm-source-22-linux-v1-${{ hashFiles('llvm-version.txt') }}
          path: |
            llvm-project/clang/lib/Headers
            llvm-project/clang/include
            llvm-project/compiler-rt
            llvm-project/lld/include
            llvm-project/llvm/include
      - name: Download LLVM source
        if: steps.cache-llvm-source.outputs.cache-hit != 'true'
        run: make llvm-source
      - name: Save LLVM source cache
        uses: actions/cache/save@v5
        if: steps.cache-llvm-source.outputs.cache-hit != 'true'
        with:
          key: ${{ steps.cache-llvm-source.outputs.cache-primary-key }}
          path: |
            llvm-project/clang/lib/Headers
            llvm-project/clang/include
            llvm-project/compiler-rt
            llvm-project/lld/include
            llvm-project/llvm/include
      - name: Restore LLVM build cache
        uses: actions/cache/restore@v5
        id: cache-llvm-build
        with:
          key: llvm-build-22-linux-${{ matrix.goarch }}-v1-${{ hashFiles('llvm-version.txt') }}
          path: llvm-build
      - name: Build LLVM
        if: steps.cache-llvm-build.outputs.cache-hit != 'true'
        run: |
          # fetch LLVM source
          rm -rf llvm-project
          make llvm-source
          # Install build dependencies.
          sudo apt-get install --no-install-recommends ninja-build
          # build!
          make llvm-build CROSS=${{ matrix.toolchain }}
          # Remove unnecessary object files (to reduce cache size).
          find llvm-build -name CMakeFiles -prune -exec rm -r '{}' \;
      - name: Save LLVM build cache
        uses: actions/cache/save@v5
        if: steps.cache-llvm-build.outputs.cache-hit != 'true'
        with:
          key: ${{ steps.cache-llvm-build.outputs.cache-primary-key }}
          path: llvm-build
      - name: Cache Binaryen
        uses: actions/cache@v5
        id: cache-binaryen
        with:
          key: binaryen-linux-${{ matrix.goarch }}-v5
          path: build/wasm-opt
      - name: Build Binaryen
        if: steps.cache-binaryen.outputs.cache-hit != 'true'
        run: |
          sudo apt-get install --no-install-recommends ninja-build
          git submodule update --init lib/binaryen
          make CROSS=${{ matrix.toolchain }} binaryen
      - name: Install fpm
        run: |
          sudo gem install --version 4.0.7 public_suffix
          sudo gem install --version 2.7.6 dotenv
          sudo gem install --no-document fpm
      - name: Build TinyGo binary
        run: |
          make CROSS=${{ matrix.toolchain }}
      - name: Download amd64 release
        uses: actions/download-artifact@v8
        with:
          name: tinygo${{ needs.build-linux.outputs.version }}.linux-amd64.tar.gz
      - name: Extract amd64 release
        run: |
          mkdir -p build/release
          tar -xf tinygo${{ needs.build-linux.outputs.version }}.linux-amd64.tar.gz -C build/release tinygo
      - name: Modify release
        run: |
          cp -p build/tinygo   build/release/tinygo/bin
          cp -p build/wasm-opt build/release/tinygo/bin
      - name: Create ${{ matrix.goarch }} release
        run: |
          make release deb RELEASEONLY=1 DEB_ARCH=${{ matrix.libc }}
          cp -p build/release.tar.gz /tmp/tinygo${{ needs.build-linux.outputs.version }}.linux-${{ matrix.goarch }}.tar.gz
          cp -p build/release.deb    /tmp/tinygo_${{ needs.build-linux.outputs.version }}_${{ matrix.libc }}.deb
      - name: "Publish release artifact: tarball"
        uses: actions/upload-artifact@v7
        with:
          name: linux-${{ matrix.goarch }}-double-zipped-${{ needs.build-linux.outputs.version }}
          path: /tmp/tinygo${{ needs.build-linux.outputs.version }}.linux-${{ matrix.goarch }}.tar.gz
          archive: false
      - name: "Publish release artifact: Debian package"
        uses: actions/upload-artifact@v7
        with:
          name: linux-${{ matrix.goarch }}-double-zipped-${{ needs.build-linux.outputs.version }}
          path: /tmp/tinygo_${{ needs.build-linux.outputs.version }}_${{ matrix.libc }}.deb
          archive: false