dfhack/.github/workflows/build.yml

name: Build

on: [push, pull_request]

jobs:
  build-linux:
    name: Build (Linux ${{ matrix.type }}, GCC ${{ matrix.gcc }})
    uses: ./.github/workflows/build-linux.yml
    with:
      artifact-name: ${{ matrix.artifact-name || format('{0}-gcc-{1}', matrix.type, matrix.gcc) }}
      append-date-and-hash: ${{ matrix.append-date-and-hash && true || false }}
      cache-id: ${{ matrix.type }}
      stonesense: ${{ matrix.stonesense }}
      docs: ${{ matrix.type == 'release' }}
      extras: ${{ matrix.extras }}
      gcc-ver: ${{ matrix.gcc }}
    secrets: inherit
    strategy:
      fail-fast: false
      matrix:
        include:
        - type: release
          gcc: "10"
          artifact-name: dfhack-linux64
          append-date-and-hash: true
          stonesense: true
          extras: false
        - type: test
          gcc: "10"
          stonesense: false
          extras: false
        - type: test
          gcc: "12"
          stonesense: true
          extras: true

  test-linux:
    name: Test (Linux, GCC ${{ matrix.gcc }}, ${{ matrix.plugins }} plugins)
    needs: build-linux
    runs-on: ubuntu-22.04
    strategy:
      fail-fast: false
      matrix:
        gcc: [10]
        plugins: [default]
        include:
        - gcc: 12
          plugins: all
    steps:
    - name: Download artifact
      uses: actions/download-artifact@v3
      with:
        name: test-${{ matrix.gcc }}
    # - name: Fetch DF cache
    #   uses: actions/cache@v3
    #   with:
    #     path: ~/DF
    #     key: df-${{ hashFiles('ci/download-df.sh') }}
    # - name: Download DF
    #   run: |
    #     sh ci/download-df.sh
    # - name: Run lua tests
    #   id: run_tests_lua
    #   run: |
    #     export TERM=dumb
    #     status=0
    #     script -qe -c "python ci/run-tests.py --headless --keep-status \"$DF_FOLDER\"" || status=$((status + 1))
    #     python ci/check-rpc.py "$DF_FOLDER/dfhack-rpc.txt" || status=$((status + 2))
    #     mkdir -p artifacts
    #     cp "$DF_FOLDER"/test*.json "$DF_FOLDER"/*.log artifacts || status=$((status + 4))
    #     exit $status
    # - name: Upload test artifacts
    #   uses: actions/upload-artifact@v3
    #   if: (success() || failure()) && steps.run_tests.outcome != 'skipped'
    #   continue-on-error: true
    #   with:
    #     name: test-artifacts-${{ matrix.gcc }}
    #     path: artifacts
    # - name: Clean up DF folder
    #   # prevent DFHack-generated files from ending up in the cache
    #   # (download-df.sh also removes them, this is just to save cache space)
    #   if: success() || failure()
    #   run: |
    #     rm -rf "$DF_FOLDER"

  package-win64:
    name: Win64 package (native)
    runs-on: windows-latest
    steps:
      - run: pip install clcache
      - run: pip install 'sphinx<4.4.0'
      - name: Fetch cache
        uses: actions/cache@v3
        with:
          path: ~/clcache
          key: clcache-win64-${{ github.sha }}
          restore-keys: |
            clcache-win64
      - name: Clone DFHack
        uses: actions/checkout@v3
        with:
          submodules: true
          fetch-depth: 0
      - name: Configure DFHack
        run: cmake -S . -B build -G "Visual Studio 17 2022" -DCMAKE_INSTALL_PREFIX=build/image -DCMAKE_C_COMPILER_LAUNCHER=clcache -DCMAKE_CXX_COMPILER_LAUNCHER=clcache -DBUILD_DOCS:BOOL=1 -DBUILD_STONESENSE:BOOL=1
      - name: Build DFHack
        run: cmake --build build -j 2 --config Release --target install
      - name: Format artifact name
        uses: benjlevesque/short-sha@v2.2
        id: short-sha
      - name: Upload artifact
        uses: actions/upload-artifact@v3
        with:
          name: dfhack-win64-build-${{ steps.short-sha.outputs.sha }}
          path: build/image/*

  build-cross-win64:
    name: Win64 package
    runs-on: ubuntu-22.04
    steps:
      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install ccache
      - name: Clone DFHack
        uses: actions/checkout@v3
        with:
          submodules: true
          fetch-depth: 0
      - name: Fetch ccache
        uses: actions/cache@v3
        with:
          path: build/win64-cross/ccache
          key: ccache-win64-cross-msvc-${{ github.sha }}
          restore-keys: |
            ccache-win64-cross-msvc
      - name: Cross-compile win64
        env:
          CMAKE_EXTRA_ARGS: '-DBUILD_STONESENSE:BOOL=1'
        run: |
          cd build
          bash -x build-win64-from-linux.sh
          ccache -d win64-cross/ccache --max-size 200M
          ccache -d win64-cross/ccache --cleanup
          ccache -d win64-cross/ccache --show-stats
      - name: Format artifact name
        id: artifactname
        run: |
          echo name=$(date +%Y%m%d)-$(git rev-parse --short HEAD) >> $GITHUB_OUTPUT
      - name: Upload artifact
        uses: actions/upload-artifact@v3
        with:
          name: dfhack-win64-build-${{ steps.artifactname.outputs.name }}
          path: build/win64-cross/output/*

  docs:
    uses: ./.github/workflows/build-linux.yml
    with:
      platform-files: false
      common-files: false
      docs: true
    secrets: inherit

  lint:
    runs-on: ubuntu-22.04
    steps:
    - name: Install Lua
      run: |
        sudo apt-get update
        sudo apt-get install lua5.3
    - name: Clone DFHack
      uses: actions/checkout@v3
      with:
        submodules: true
    - name: Check whitespace
      run: python ci/lint.py --git-only --github-actions
    - name: Check Authors.rst
      if: always()
      run: python ci/authors-rst.py
    - name: Check for missing documentation
      if: always()
      run: python ci/script-docs.py
    - name: Check Lua syntax
      if: always()
      run: python ci/script-syntax.py --ext=lua --cmd="luac5.3 -p" --github-actions

  check-pr:
    runs-on: ubuntu-latest
    if: github.event_name == 'pull_request'
    steps:
    - name: Check that PR is based on develop branch
      env:
        BASE_BRANCH: ${{ github.base_ref }}
      run: |
        echo "PR base branch: $BASE_BRANCH"
        test "$BASE_BRANCH" = develop