.gitlab-ci.yml

image: python:3.11

stages:
  - test-and-build
  # published docs are easy to overwrite, published pkg isn't => do last
  - publish-docs
  - publish-package

variables:
  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"

cache:
  paths:
    - .cache/pip
    - venv/

before_script:
  - python --version
  - pip install virtualenv
  - virtualenv venv
  - source venv/bin/activate

test:
  stage: test-and-build
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
          || $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
  script:
    - pip install poetry
    - poetry install --extras=all
    - python -m flake8
    - python -m isort --check .
    - python -m black --check .
    - python -m mypy .
    - pytest

build package:
  stage: test-and-build
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
          || $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
          || $CI_COMMIT_TAG =~ /^v\d+.\d+.\d+-?.*$/
  script:
    - pip install build twine
    - python -m build --sdist
    - twine check dist/*
  artifacts:
    paths:
      - dist/*

publish package:
  stage: publish-package
  variables:
    TWINE_USERNAME: __token__
    TWINE_PASSWORD: $PYPI_TOKEN
  rules:
    - if: $CI_COMMIT_TAG =~ /^v\d+.\d+.\d+-?.*$/
  script:
    - pip install twine
    - twine check dist/*
    - twine upload dist/*

build docs:
  stage: test-and-build
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
          || $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
          || $CI_COMMIT_TAG =~ /^v\d+.\d+.\d+-?.*$/
  script:
    - pip install poetry
    - poetry install --with=doc
    - ( cd doc && make html )
    - mv doc/_build/html built-docs
  artifacts:
    paths:
      - built-docs

pages:
  stage: publish-docs
  rules:
    - if: $CI_COMMIT_TAG =~ /^v\d+.\d+.\d+-?.*$/
  script:
    - mv built-docs public
  artifacts:
    paths:
      - public