ci.yaml

name: test
on:
  push:
    branches:
      - main
    tags:
      - 'v*'
  pull_request:
    branches:
      - main

jobs:
  # Downloads LuaLs and EmmyLua binaries for all OSes and uploads them as an
  # artifact so that the test job can re-use them without re-downloading.
  prepare:
    name: Download LuaLs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout source
        uses: actions/checkout@v6
        with:
          fetch-depth: 0
      - name: Set up python ${{ matrix.python-version }}
        uses: actions/setup-python@v6
        with:
          python-version: "3.12"
      - name: Update pip
        run: python -m pip install --upgrade pip
      - name: Install dependencies
        run: python -m pip install '.'
      - name: Download LuaLs for Linux
        run: python -m sphinx_lua_ls.lua_ls linux x86_64 --runtime luals ~/lua_ls_release/ubuntu-latest
      - name: Download LuaLs for Windows
        run: python -m sphinx_lua_ls.lua_ls win32 amd64 --runtime luals ~/lua_ls_release/windows-latest
      - name: Download LuaLs for MacOs
        run: python -m sphinx_lua_ls.lua_ls darwin arm --runtime luals ~/lua_ls_release/macos-latest
      - name: Download EmmyLua for Linux
        run: python -m sphinx_lua_ls.lua_ls linux x86_64 --runtime emmylua ~/lua_ls_release/ubuntu-latest
      - name: Download EmmyLua for Windows
        run: python -m sphinx_lua_ls.lua_ls win32 amd64 --runtime emmylua ~/lua_ls_release/windows-latest
      - name: Download EmmyLua for MacOs
        run: python -m sphinx_lua_ls.lua_ls darwin arm --runtime emmylua ~/lua_ls_release/macos-latest
      - name: Upload artifact
        uses: actions/upload-artifact@v7
        with:
          name: lua_ls_release
          path: ~/lua_ls_release
          include-hidden-files: true
          retention-days: 3

  # Runs main tests for the package.
  #
  # Runs on all events except when closing a pull request.
  test:
    name: Test package
    needs:
      - prepare
    strategy:
      fail-fast: false
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
        type:
          - test
        include:
          - os: ubuntu-latest
            python-version: "3.13"
            type: code style
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout source
        uses: actions/checkout@v6
        with:
          fetch-depth: 0
      - name: Install UV
        uses: astral-sh/setup-uv@v7
      - name: Install dependencies
        run: |
          uv tool install poethepoet
      # Tests
      - name: Download LuaLs
        if: ${{ matrix.type == 'test' }}
        uses: actions/download-artifact@v8
        with:
          name: lua_ls_release
          path: ~/lua_ls_release
      - name: Test package
        if: ${{ matrix.type == 'test' }}
        run: |
          poe ci
        env:
          LUA_LS_CACHE_PATH: ~/lua_ls_release/${{ matrix.os }}
      # Lint
      - name: Check code style
        if: ${{ matrix.type == 'code style' }}
        run: |
          poe lint --color always

  # Builds python packages.
  #
  # Only runs on tag pushes.
  build:
    name: Build package
    if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') }}
    runs-on: ubuntu-latest
    outputs:
      link: ${{ steps.metadata.outputs.link }}
      is-pre-release: ${{ steps.changelog.outputs.is-pre-release }}
      is-unreleased: ${{ steps.changelog.outputs.is-unreleased }}
      changelog-text: ${{ steps.changelog.outputs.text }}
    steps:
      - name: Checkout source
        uses: actions/checkout@v6
        with:
          fetch-depth: 0
      - name: Generate release metadata
        id: metadata
        run: |
          ref="${{ github.ref }}";
          version=${ref#refs/tags/v};
          link="https://pypi.org/p/sphinx-lua-ls/${version}/";
          echo "link=${link}" >> $GITHUB_OUTPUT
      - name: Parse Changelog
        id: changelog
        uses: taminomara/cl-keeper@v1
        with:
          version: ${{ github.ref }}
      - name: Install UV
        uses: astral-sh/setup-uv@v7
      - name: Build project
        run: |
          uv build
      - name: Upload the build artifact
        uses: actions/upload-artifact@v7
        with:
          name: python-package-distributions
          path: dist/

  # Publishes python packages.
  #
  # Only runs on tag pushes.
  publish_to_pypi:
    name: Publish package to PyPi
    needs:
      - test
      - build
    if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') }}
    runs-on: ubuntu-latest
    environment:
      name: pypi
      url: https://pypi.org/p/sphinx-lua-ls
    permissions:
      contents: write
      id-token: write
    steps:
      - name: Download build artifact
        uses: actions/download-artifact@v8
        with:
          name: python-package-distributions
          path: dist/
      - name: Publish to pypi
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          attestations: false
      - name: Create GitHub release
        uses: softprops/action-gh-release@v3
        with:
          prerelease: ${{ fromJSON(needs.build.outputs.is-pre-release) }}
          draft: ${{ fromJSON(needs.build.outputs.is-unreleased) }}
          body: |
            ## Changelog

            ${{ needs.build.outputs.changelog-text }}

            [See release on PyPi](${{ needs.build.outputs.link }})