ci-python.yml

name: Build and test Python package

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  linting:
    name: Linting
    strategy:
      matrix:
        python-version:
          - "3.9"
          - "3.10"
          - "3.11"
          - "3.12"
    uses: greenbone/workflows/.github/workflows/lint-python.yml@main
    with:
      linter: ruff check
      lint-packages: gvmtools tests
      python-version: ${{ matrix.python-version }}

  lint-scripts:
    name: Lint all scripts
    runs-on: "ubuntu-latest"
    strategy:
      matrix:
        python-version:
          - "3.9"
          - "3.10"
          - "3.11"
          - "3.12"
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      - name: Set up Python ${{ matrix.python-version }}
        uses: greenbone/actions/poetry@45b6e84c655954002872d0ac6c8d31b2f213c9a0 # v3.27.17
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install additional script dependencies
        run: poetry run pip install -r scripts/requirements.txt
      - name: Check with black
        run: poetry run black --check scripts/*.gmp.py
      - name: Lint scripts
        run: |
          poetry run ruff check --config scripts/ruff.toml scripts/*.py

  test:
    name: Unit tests
    strategy:
      matrix:
        python-version:
          - "3.9"
          - "3.10"
          - "3.11"
          - "3.12"
    uses: greenbone/workflows/.github/workflows/test-python.yml@main
    with:
      python-version: ${{ matrix.python-version }}

  codecov:
    name: Upload coverage to codecov.io
    needs: test
    runs-on: "ubuntu-latest"
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      - name: Calculate and upload coverage to codecov.io
        uses: greenbone/actions/coverage-python@45b6e84c655954002872d0ac6c8d31b2f213c9a0 # v3.27.17
        with:
          token: ${{ secrets.CODECOV_TOKEN }}

  build-docs:
    name: Build the documentation
    runs-on: "ubuntu-latest"
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      - name: Install poetry and dependencies
        uses: greenbone/actions/poetry@45b6e84c655954002872d0ac6c8d31b2f213c9a0 # v3.27.17
      - name: Build docs
        run: |
          cd docs
          poetry run make html

  versioning:
    name: Check versioning
    uses: greenbone/workflows/.github/workflows/check-version.yml@main