android_sdk.yml

# This workflow can be added to a branch of swift-docker
# in order to test building the chages in a fork:
#
# ln ../android_sdk.yml .github/workflows/android_sdk.yml
#
# Note that the workflow should be removed before filing a PR
# so it is not submitted to the upstream swiftlang/swift-docker repo
name: Build Android SDK
on: [push, pull_request]

jobs:
   build:
     name: Android ${{ matrix.build-type }} ${{ matrix.swift-version }} ${{ matrix.arch }} ${{ matrix.runner }} (compiler=${{ matrix.build-compiler }})
     strategy:
       fail-fast: false
       matrix:
         include:
           - runner: 'ubuntu-24.04'
             swift-version: 'scheme:main'
             build-type: 'docker'
           - runner: 'ubuntu-24.04'
             swift-version: 'scheme:release/6.2'
             build-type: 'docker'
           - runner: 'ubuntu-24.04'
             swift-version: 'tag:swift-6.2.3-RELEASE'
             build-type: 'docker'
           - runner: 'ubuntu-24.04'
             swift-version: 'tag:swift-6.3-DEVELOPMENT-SNAPSHOT-2025-12-24-a'
             build-type: 'docker'
     runs-on: ${{ matrix.runner }}
     # 16 hour timeout
     timeout-minutes: 960
     steps:
      - name: Free Disk Space
        if: ${{ matrix.runner != 'self-hosted' }}
        run: |
          df -h
          # brings available space from 25G to 32G
          # otherwise we sometimes run out of space during the build
          sudo rm -rf /opt/microsoft /opt/google /opt/az /usr/share/miniconda /usr/share/az* /usr/share/glade* /usr/local/share/chromium /usr/local/share/powershell /usr/share/dotnet /opt/ghc /opt/hostedtoolcache /usr/local/graalvm/ /usr/local/.ghcup/ /usr/local/lib/node_modules /usr/local/share/boost
          sudo docker image prune --all --force
          sudo docker builder prune -a
          df -h
      - name: Setup
        id: config
        run: |
          # these variabes are used by build-docker and build-local
          # to determine which Swift version to build for
          echo "SWIFT_VERSION=${{ matrix.swift-version }}" >> $GITHUB_ENV
          # pass the build-compiler matrix through to the build script
          echo "BUILD_COMPILER=${{ matrix.build-compiler }}" >> $GITHUB_ENV
          echo "TARGET_ARCHS=${{ matrix.arch }}" >> $GITHUB_ENV
          echo "WORKDIR=${{ runner.temp }}/swift-android-sdk" >> $GITHUB_ENV
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Build Android SDK (Local)
        if: ${{ matrix.build-type == 'local' }}
        working-directory: swift-ci/sdks/android
        run: |
          sudo apt install -q patchelf build-essential cmake ninja-build python3 golang git gnupg2 libcurl4-openssl-dev libedit-dev libicu-dev libncurses5-dev libpython3-dev libsqlite3-dev libxml2-dev rsync uuid-dev uuid-runtime tzdata curl unzip
          ./build-local ${SWIFT_VERSION} ${WORKDIR}
      - name: Build Android SDK (Docker)
        if: ${{ matrix.build-type == 'docker' }}
        working-directory: swift-ci/sdks/android
        run: |
          ./build-docker ${SWIFT_VERSION} ${WORKDIR}
      - name: Install Host Toolchain
        if: ${{ matrix.build-type == 'docker' }}
        working-directory: swift-ci/sdks/android
        run: |
          # when building in a Docker container, we don't have a local host toolchain,
          # but we need one in order to run the SDK validation tests, so we install it now
          HOST_OS=ubuntu$(lsb_release -sr)
          source ./scripts/toolchain-vars.sh
          mkdir -p ${WORKDIR}/host-toolchain
          ./scripts/install-swift.sh ${WORKDIR}/host-toolchain/$SWIFT_BASE/usr
          ls ${WORKDIR}/host-toolchain
          ${WORKDIR}/host-toolchain/*/usr/bin/swift --version
      - name: Get artifact info
        id: info
        shell: bash
        run: |
          set -ex
          SWIFT_ROOT=$(dirname ${WORKDIR}/host-toolchain/*/usr)
          echo "swift-root=${SWIFT_ROOT}" >> $GITHUB_OUTPUT
          echo "swift-path=${SWIFT_ROOT}/usr/bin/swift" >> $GITHUB_OUTPUT

          ARTIFACT_PATH=$(realpath ${WORKDIR}/products/*.artifactbundle.tar.gz)
          echo "artifact-path=${ARTIFACT_PATH}" >> $GITHUB_OUTPUT
          echo "sdk-id=x86_64-unknown-linux-android28" >> $GITHUB_OUTPUT

          ARTIFACT_EXT=".artifactbundle.tar.gz"
          ARTIFACT_NAME="$(basename ${ARTIFACT_PATH} ${ARTIFACT_EXT})"
          # depending on whether we are building locally or in a container, add a maker to the name
          if [[ "${{ matrix.build-type }}" == 'local' ]]; then
            ARTIFACT_NAME="${ARTIFACT_NAME}-local"
          fi
          if [[ "${{ matrix.build-compiler }}" == '1' ]]; then
            ARTIFACT_NAME="${ARTIFACT_NAME}-hostbuild"
          fi
          # artifacts need a unique name so we suffix with the matrix arch(s)
          if [[ ! -z "${{ matrix.arch }}" ]]; then
            ARTIFACT_NAME="${ARTIFACT_NAME}-$(echo ${{ matrix.arch }} | tr ',' '-')"
          fi
          ARTIFACT_NAME="${ARTIFACT_NAME}${ARTIFACT_EXT}"

          # There is no way to prevent even a single-file artifact from being zipped:
          # https://github.com/actions/upload-artifact?tab=readme-ov-file#zip-archives
          # so the actual artifact download will look like:
          # swift-6.1-RELEASE_android-0.1-x86_64.artifactbundle.tar.gz.zip
          echo "artifact-name=${ARTIFACT_NAME}" >> $GITHUB_OUTPUT
      - name: Upload SDK artifactbundle
        uses: actions/upload-artifact@v4
        with:
          compression-level: 0
          name: ${{ steps.info.outputs.artifact-name }}
          path: ${{ steps.info.outputs.artifact-path }}
      - name: Cleanup
        if: ${{ matrix.runner != 'self-hosted' }}
        run: |
          # need to free up some space or else when installing we get: No space left on device
          df -h
          rm -rf ${WORKDIR}/{build,source}
          sudo docker image prune --all --force
          sudo docker builder prune -a
          df -h
      - name: Install artifactbundle
        if: ${{ matrix.runner != 'self-hosted' }}
        shell: bash
        run: |
          set -ex
          ${{ steps.info.outputs.swift-path }} sdk install ${{ steps.info.outputs.artifact-path }}
          ${{ steps.info.outputs.swift-path }} sdk configure --show-configuration $(${{ steps.info.outputs.swift-path }} sdk list | head -n 1) ${{ steps.info.outputs.sdk-id }}
          # recent releases require that ANDROID_NDK_ROOT *not* be set
          # see https://github.com/swiftlang/swift-driver/pull/1879
          echo "ANDROID_NDK_ROOT=" >> $GITHUB_ENV

      - name: Create Demo Project
        if: ${{ matrix.runner != 'self-hosted' }}
        run: |
          cd ${{ runner.temp }}
          mkdir DemoProject
          cd DemoProject
          ${{ steps.info.outputs.swift-path }} --version
          ${{ steps.info.outputs.swift-path }} package init
          echo 'import Foundation' >> Sources/DemoProject/DemoProject.swift
          echo 'import FoundationEssentials' >> Sources/DemoProject/DemoProject.swift
          echo 'import FoundationXML' >> Sources/DemoProject/DemoProject.swift
          echo 'import FoundationNetworking' >> Sources/DemoProject/DemoProject.swift
          echo 'import Dispatch' >> Sources/DemoProject/DemoProject.swift
          echo 'import Android' >> Sources/DemoProject/DemoProject.swift
      - name: Test Demo Project on Android
        uses: skiptools/swift-android-action@main
        if: ${{ matrix.runner != 'self-hosted' }}
        with:
          # only test for the complete arch SDK build to speed up CI
          #run-tests: ${{ matrix.arch == '' }}
          package-path: ${{ runner.temp }}/DemoProject
          installed-sdk: ${{ steps.info.outputs.sdk-id }}
          installed-swift: ${{ steps.info.outputs.swift-root }}

      - name: Checkout swift-algorithms
        if: ${{ matrix.runner != 'self-hosted' }}
        uses: actions/checkout@v4
        with:
          repository: apple/swift-algorithms
          path: swift-algorithms
      - name: Test swift-algorithms
        if: ${{ matrix.runner != 'self-hosted' }}
        uses: skiptools/swift-android-action@main
        with:
          package-path: swift-algorithms
          installed-sdk: ${{ steps.info.outputs.sdk-id }}
          installed-swift: ${{ steps.info.outputs.swift-root }}