actions.yml

---
# Taken from pyhaversion
name: Actions

on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main

jobs:
  changes:
    runs-on: ubuntu-latest
    outputs:
      docfiles: ${{ steps.filter.outputs.docfiles }}
    steps:
      - uses: actions/checkout@v4.2.2
      - uses: dorny/paths-filter@v3.0.2
        id: filter
        with:
          filters: |
            docfiles:
              - 'src/pysmsboxnet/*.py'
              - 'docs/**'
              - 'pyproject.toml'

  lint:
    name: Lint
    runs-on: ubuntu-latest
    steps:
      - name: 📥 Checkout the repository
        uses: actions/checkout@v4.2.2

      - name: 🛠 Set up UV and Python 3
        uses: astral-sh/setup-uv@v5.2.1
        id: python
        with:
          enable-cache: true
          cache-suffix: lint

      - name: 📦 Install dependencies
        run: uv sync --frozen --group lint

      - name: Pre-commit cache
        uses: actions/cache@v4.2.0
        with:
          path: ~/.cache/pre-commit
          key: "${{ runner.os }}-pc-${{ hashFiles('.pre-commit-config.yaml') }}"
          restore-keys: |
            ${{ runner.os }}-pre-commit-

      - name: "🖤  Run pre-commits"
        run: uv run pre-commit run --show-diff-on-failure --all-files

  test:
    name: Test with Python ${{ matrix.python-version }} on ${{ matrix.os }}
    needs: lint
    runs-on: ${{ matrix.os }}-latest
    strategy:
      matrix:
        python-version: ["3.10", 3.11, 3.12]
        os: [ubuntu, windows, macos]
    steps:
      - name: 📥 Checkout the repository
        uses: actions/checkout@v4.2.2

      - name: 🛠️ Set up UV and Python ${{ matrix.python-version }}
        uses: astral-sh/setup-uv@v5.2.1
        with:
          enable-cache: true
          cache-suffix: test-${{ matrix.python-version }}-${{ matrix.os }}

      - name: install Python ${{ matrix.python-version }}
        run: uv python install ${{ matrix.python-version }}

      - name: 📦 Install dependencies
        run: uv sync --frozen --group test

      - name: 🏃 Run tests
        run: uv run pytest tests

      - name: Run code coverage
        if: ${{ matrix.python-version == '3.10' }}
        run: uv run pytest --cov=./src --cov-report=xml tests

      - name: upload to codecov
        if: ${{ matrix.python-version == '3.10' }}
        uses: codecov/codecov-action@v5.1.2

  test_install:
    name: "Test install with Python ${{matrix.python-version}} ${{matrix.os}}"
    needs: test
    runs-on: ${{ matrix.os }}-latest
    strategy:
      matrix:
        python-version: ["3.10", 3.11, 3.12]
        os: [ubuntu, windows, macos]
    steps:
      - name: 📥 Checkout the repository
        uses: actions/checkout@v4.2.2

      - name: 🛠️ Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5.3.0
        with:
          python-version: ${{ matrix.python-version }}
          check-latest: true

      - name: Install using pip
        run: pip3 install .

      - name: Try example in temporary directory
        env:
          SMSBOX_API_KEY: ${{ secrets.SMSBOX_API_KEY }}
          RUNNER_TEMP: ${{ runner.temp }}
        run: |
          python3 script/copy_example.py
          cd ${{ runner.temp }}/test_example
          python3 ${{ runner.temp }}/test_example/example.py

  test_build:
    name: Test building  with Python 3
    needs: test_install
    runs-on: ubuntu-latest
    steps:
      - name: 📥 Checkout the repository
        uses: actions/checkout@v4.2.2

      - name: 🛠️ Set up Python 3 and UV
        uses: astral-sh/setup-uv@v5.2.1
        id: python

      - name: Run build
        run: uv build

  deploy_doc:
    if: github.event_name == 'push' && needs.changes.outputs.docfiles == 'true'
    needs: [test_build, changes]
    permissions:
      contents: write
    runs-on: ubuntu-latest
    name: Build and deploydocumentation from main
    steps:
      - name: 📥 Checkout the repository
        uses: actions/checkout@v4.2.2
        with:
          fetch-depth: 0

      - name: 🛠 Set up Python3
        uses: astral-sh/setup-uv@v5.2.1
        id: python

      - name: 📦 Install dependencies
        run: uv sync --frozen --group doc

      - name: Build documentation using sphinx
        run: uv run make -C docs html

      - name: deploy documentation
        uses: JamesIves/github-pages-deploy-action@v4.7.2
        with:
          folder: docs/_build/html
          target-folder: dev

  alls_green:
    name: Check if all checks are green
    if: always()
    needs:
      - lint
      - test
      - test_install
      - test_build
    runs-on: ubuntu-latest
    steps:
      - name: Decide if checks succeeded or not
        uses: re-actors/alls-green@v1.2.2
        with:
          allowed-skips: changes
          jobs: ${{ toJSON(needs) }}