WIP

Author: sjvrijn

template/.gitlab-ci.yml

@@ -1,5 +1,11 @@
 # Change pip's cache directory to be inside the project directory since we can
 # only cache local items.
+
+stages:
+  - lint   # Fastest check first
+  - test   # Then test
+  - build  # build package and documentation when verified correct
+
 variables:
   PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
 
@@ -24,13 +30,13 @@ test:
     - python --version
     # Install dependencies
     - python -m pip install --upgrade pip setuptools
-    - python -m pip install --editable ".[dev]"
+    - python -m pip install --editable .[dev]
   script:
     # Run pytest
     - python -m pytest -v --durations=0
 
 cffconvert:
-  stage: test
+  stage: lint
   image:
     name: "citationcff/cffconvert:2.0.0"
     entrypoint: [""]
@@ -46,7 +52,7 @@ cffconvert:
     - cffconvert --validate
 
 markdown-link-check:
-  stage: test
+  stage: lint
   image:
     name: "lycheeverse/lychee"
     entrypoint: [""]
@@ -57,3 +63,64 @@ markdown-link-check:
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
   script:
     - lychee .
+
+lint:
+  stage: lint
+  image: "python:3.12"
+  rules:
+    # Run on a Merge Request to the default branch
+    - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
+    # Run on new commits to the default branch
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+  before_script:
+    # Python info
+    - which python
+    - python --version
+    # Install dependencies
+    - python -m pip install ruff
+  script:
+    # Run pytest
+    - ruff check
+    - ruff format --check
+
+build:
+  stage: build
+  image: "python:$VERSION"
+  rules:
+    # Run on a Merge Request to the default branch
+    - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
+    # Run on new commits to the default branch
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+  parallel:
+    matrix:
+      - VERSION: ['3.8', '3.9', '3.10', '3.11', '3.12']
+  before_script:
+    # Python info
+    - which python
+    - python --version
+    # Install dependencies
+    - python -m pip install --upgrade pip setuptools
+    - python -m pip install --editable .[publishing]
+  script:
+    # Run pytest
+    - python -m build
+
+documentation:
+  stage: build
+  image: "python:3.12"
+  rules:
+    # Run on a Merge Request to the default branch
+    - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
+    # Run on new commits to the default branch
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+  before_script:
+    # Python info
+    - which python
+    - python --version
+    # Install dependencies
+    - python -m pip install .[docs]
+    - sudo apt install pandoc
+  script:
+    # Run pytest
+    - cd docs
+    - make coverage doctest html