build.yml

name: Build

on: [push, pull_request]

jobs:
  validate:
    runs-on: ubuntu-22.04
    steps:
    - name: Install dependencies
      run: |
        sudo apt-get update
        sudo apt-get install \
            libxml2-utils \
            libxml-libxml-perl \
            libxml-libxslt-perl
    - name: Clone df-structures
      uses: actions/checkout@v4
    - name: Validate against schema
      run: |
        xmllint --schema data-definition.xsd --noout df.*.xml symbols.xml 2>&1 | tee xmllint.out; status=${PIPESTATUS[0]}
        echo "** reformatted output: **"
        grep -i error xmllint.out | perl -pe 's/(.+):(\d+):/::error file=\1,line=\2::/g'
        exit $status
    - name: Generate headers
      shell: bash
      run: |
        perl ./codegen.pl | tee codegen.out
        if grep -i error codegen.out; then
          echo codegen produced error
          exit 1
        fi
    - name: Verify list.pl output
      run: |
        ls codegen | sort | grep -v codegen.out.xml > ls.out
        perl ./list.pl | cut -d/ -f2 | sort > list.pl.out
        diff ls.out list.pl.out

  dfhack-ref:
    runs-on: ubuntu-latest
    outputs:
      ref: ${{ steps.resolve.outputs.ref }}
    steps:
      - id: resolve
        env:
          REPO: ${{ format('{0}/dfhack', github.event_name == 'push' && github.repository_owner || github.event.pull_request.base.repo.owner.login) }}
          BRANCH: ${{ github.base_ref || github.ref_name }}
        run: |
          ref="$BRANCH"
          [ "$ref" = master ] && ref=develop
          if [ "$ref" != develop ] && ! git ls-remote --exit-code --heads "https://github.com/$REPO" "$ref" >/dev/null 2>&1; then
            echo "no '$ref' branch in $REPO; falling back to develop"
            ref=develop
          fi
          echo "ref=$ref" >> "$GITHUB_OUTPUT"

  test:
    needs: dfhack-ref
    uses: DFHack/dfhack/.github/workflows/test.yml@develop
    with:
      dfhack_repo: ${{ format('{0}/dfhack', github.event_name == 'push' && github.repository_owner || github.event.pull_request.base.repo.owner.login) }}
      dfhack_ref: ${{ needs.dfhack-ref.outputs.ref }}
      structures_repo: ${{ github.repository }}
      structures_ref: ${{ github.ref }}
    secrets: inherit

  docs:
    needs: dfhack-ref
    uses: DFHack/dfhack/.github/workflows/build-linux.yml@develop
    with:
      dfhack_repo: ${{ format('{0}/dfhack', github.event_name == 'push' && github.repository_owner || github.event.pull_request.base.repo.owner.login) }}
      dfhack_ref: ${{ needs.dfhack-ref.outputs.ref }}
      structures_repo: ${{ github.repository }}
      structures_ref: ${{ github.ref }}
      artifact-name: docs
      platform-files: false
      common-files: false
      docs: true
    secrets: inherit