build-test-publish.yml

# Builds on all branches & PRs
# Deploys to PyPi on "release".
name: Build, test and publish

on:
  push:
    branches:
      - master
      - release
      - version/*
    tags:
      - "*"
  pull_request: {}

jobs:
  cache:
    runs-on: ubuntu-latest
    name: Build Python package cache
    strategy:
      fail-fast: false
      matrix:
        python-version: [ "3.10", "3.11", "3.12", "3.13" ]
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: 'recursive'
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Set up Rust toolchain
      uses: dtolnay/rust-toolchain@stable
    - uses: actions/cache@v4
      with:
        # We do this per Run, since the requirements.txt contains references to Git repos that might have changed.
        path: ${{ env.pythonLocation }}
        key: py${{ matrix.python-version }}-${{ github.run_id }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt

  linting:
    runs-on: ubuntu-latest
    needs: cache
    name: Linting
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: 'recursive'
    - name: Set up Python 3.11
      uses: actions/setup-python@v5
      with:
        python-version: "3.11"
    - uses: actions/cache@v4
      with:
        path: ${{ env.pythonLocation }}
        key: py3.11-${{ github.run_id }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt
    - name: Lint with ruff
      run: ruff check --output-format=github .

  code-formatting:
    runs-on: ubuntu-latest
    needs: cache
    name: Code Format
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: 'recursive'
      - name: Set up Python 3.11
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - uses: actions/cache@v4
        with:
          path: ${{ env.pythonLocation }}
          key: py3.11-${{ github.run_id }}
      - name: Check with ruff
        run: ruff format --check .

  typechecks:
    runs-on: ubuntu-latest
    name: Type checks
    needs: cache
    strategy:
      fail-fast: false
      matrix:
        python-version: [ "3.10", "3.11", "3.12", "3.13" ]
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: 'recursive'
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - uses: actions/cache@v4
      with:
        path: ${{ env.pythonLocation }}
        key: py${{ matrix.python-version }}-${{ github.run_id }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip setuptools
        pip install -r requirements.txt mypy
    - name: Run type checks
      run: |
        mypy --config-file mypy.ini --junit-xml mypy-${{ matrix.python-version }}.xml skytemple_files
    - name: Upload Unit Test Results
      if: always()
      uses: actions/upload-artifact@v4
      with:
        name: MyPy Test Results (Python ${{ matrix.python-version }})
        path: mypy-${{ matrix.python-version }}.xml

  test:
    runs-on: ubuntu-latest
    needs: cache
    name: Runs tests
    strategy:
      fail-fast: false
      matrix:
        python-version: [ "3.10", "3.11", "3.12", "3.13" ]
        native: [true, false]
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: 'recursive'
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - uses: actions/cache@v4
      with:
        path: ${{ env.pythonLocation }}
        key: py${{ matrix.python-version }}-${{ github.run_id }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip setuptools
        pip install tox tox-gh-actions
    - name: Enable native modules
      if: matrix.native
      run: |
        echo "SKYTEMPLE_USE_NATIVE=1" >> $GITHUB_ENV
    - uses: dtolnay/rust-toolchain@stable
    - name: Test with tox
      run: tox -- -m "not romtest"
      working-directory: test
    - run: mv test/pytest.xml test/pytest-${{ matrix.python-version }}-${{ matrix.native }}.xml
    - name: Upload Test Results
      if: always()
      uses: actions/upload-artifact@v4
      with:
        name: "Pytest Test Results (Python ${{ matrix.python-version }} - Native ${{ matrix.native }})"
        path: test/pytest-${{ matrix.python-version }}-${{ matrix.native }}.xml

  test_with_rom:
   # This uses a self-hosted runner with access to the ROM at /rom.nds.
   runs-on: ["self-hosted", "romtest"]
   name: Runs tests with real ROM
   strategy:
     fail-fast: false
     matrix:
       python-version: [ "3.10" ]
       native: [true, false]
   steps:
   - uses: actions/checkout@v4
     with:
       submodules: 'recursive'
   - name: Set up Python ${{ matrix.python-version }}
     uses: actions/setup-python@v5
     with:
       python-version: ${{ matrix.python-version }}
   - name: Install dependencies
     run: |
       python -m pip install --upgrade pip
       pip install tox tox-gh-actions
   - name: Enable native modules
     if: matrix.native
     run: |
       echo "SKYTEMPLE_USE_NATIVE=1" >> $GITHUB_ENV
   - uses: dtolnay/rust-toolchain@stable
   - name: Test with tox
     run: tox -- -m "romtest"
     working-directory: test
     env:
       SKYTEMPLE_TEST_ROM: /rom.nds
   - run: mv test/pytest.xml test/pytest-romtest-${{ matrix.python-version }}-${{ matrix.native }}.xml
   - name: Upload Test Results
     if: always()
     uses: actions/upload-artifact@v4
     with:
       name: "Pytest ROM Test Results (Python ${{ matrix.python-version }}) - Native ${{ matrix.native }})"
       path: test/pytest-romtest-${{ matrix.python-version }}-${{ matrix.native }}.xml

  test-event-file:
    name: "Publish Test Results Event File"
    runs-on: ubuntu-latest
    steps:
    - name: Upload
      uses: actions/upload-artifact@v4
      with:
        name: Event File
        path: ${{ github.event_path }}

  build:
    needs:
      - test
      - test_with_rom
      - typechecks
    runs-on: ubuntu-latest
    name: Build the Python wheel
    steps:
      # For tags we assume the version in pyproject.toml is correct!
      - name: Checkout
        uses: actions/checkout@v4
        with:
          submodules: 'recursive'
      - name: Rewrite version for dev if not tag
        if: "!startsWith(github.ref, 'refs/tags/')"
        run: |
          perl -i -pe "s/version\s*=\s*\"(.*?)(\.rc.*|\.a.*|\.post.*)?\"/version=\"\1.dev0+${GITHUB_SHA::8}\"/" pyproject.toml
      - name: Note version
        run: |
          echo "PACKAGE_VERSION=$(tomlq '.project.version' pyproject.toml -r)" >> $GITHUB_ENV
      - name: Build Python wheels
        run: |
          python3 -m pip install --upgrade build
          python3 -m build
      - name: Upload wheels
        uses: actions/upload-artifact@v4
        with:
          name: wheels
          path: dist/*.whl

  deploy:
    if: startsWith(github.ref, 'refs/tags/')
    needs: build
    runs-on: ubuntu-latest
    name: Deploy wheels to PyPI
    steps:
      - name: Download wheels
        uses: actions/download-artifact@v4
        with:
          name: wheels
      - name: Set up Python 3.11
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - name: Upgrade pip and install Twine
        run: |
          python -m pip install --upgrade pip
          pip install twine
      - name: Publish wheels to PyPI
        env:
          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
        run: |
          twine upload *.whl