.gitlab-ci.yml

stages:
  - image-pixi
  - image
  - lint
  - test
  - doc
  - deploy
  - build
  - release

variables:
  PDM_CACHE_DIR: ${CI_PROJECT_DIR}/.pdm-cache
  DOCKER_IMAGE_PATH: registry.heptapod.net:443/fluiddyn/fluiddyn/ci/default

image: $DOCKER_IMAGE_PATH:stable

image-pixi:build:
  stage: image-pixi
  tags:
    - container-registry-push
  rules:
    - if: '$CI_PIPELINE_SOURCE == "schedule"'
    - if: '$CI_BUILD_IMAGES == "1"'
  image:
    name: gcr.io/kaniko-project/executor:debug
    entrypoint: [ "" ]
  before_script:
    - ""
  script:
    - |
      cat > /kaniko/.docker/config.json <<EOF
      {
        "auths": {
          "$CI_REGISTRY": {
            "username": "$CI_REGISTRY_USER",
            "password": "$CI_REGISTRY_PASSWORD"
          }
        }
      }
      EOF
    - >
      /kaniko/executor --context $CI_PROJECT_DIR
      --dockerfile $CI_PROJECT_DIR/docker/Dockerfile_pixi
      --single-snapshot
      --cleanup
      --destination $DOCKER_IMAGE_PATH:pixi


# Build an image for the above tasks; this should be a scheduled job, as
# it is quite unnecessary to run on every invocation.
image:build:
  stage: image
  tags:
    - container-registry-push
  needs: []
  # comment these rules for MR modifying the Docker file
  rules:
    - if: '$CI_PIPELINE_SOURCE == "schedule"'
    - if: '$CI_BUILD_IMAGES == "1"'
  image:
    name: gcr.io/kaniko-project/executor:debug
    entrypoint: [ "" ]
  before_script:
    - ""
  script:
    - |
      cat > /kaniko/.docker/config.json <<EOF
      {
        "auths": {
          "$CI_REGISTRY": {
            "username": "$CI_REGISTRY_USER",
            "password": "$CI_REGISTRY_PASSWORD"
          }
        }
      }
      EOF
    - >
      /kaniko/executor --context $CI_PROJECT_DIR
      --dockerfile $CI_PROJECT_DIR/docker/Dockerfile
      --single-snapshot
      --cleanup
      --destination $DOCKER_IMAGE_PATH:stable


validate_style:
  stage: lint
  needs:
    - job: "image:build"
      optional: true
  script:
    - black --diff --check fluiddyn fluiddoc

validate_min_version:
  stage: lint
  needs:
    - job: "image:build"
      optional: true
  script:
    - vermin --no-parse-comments --lint --target=3.9 --no-tips  fluiddyn fluiddoc
  allow_failure: true

validate_imports:
  stage: lint
  needs:
    - job: "image:build"
      optional: true
  script:
    - isort . --verbose --check-only --only-modified --diff


test:run:
  stage: test
  script:
    - nox -s test
  needs:
    - job: "image:build"
      optional: true
  artifacts:
    when: always
    paths:
      - .coverage/as_junit.xml
      - .coverage/index.html
    reports:
      junit: .coverage/as_junit.xml

doc:build:
  stage: doc
  image: sphinxdoc/sphinx:5.3.0
  before_script:
    - pip install pdm
    - pdm install -G doc
  script:
    - pdm run make -C doc
  artifacts:
    paths:
      - doc/_build/html
  needs:
    - job: "image:build"
      optional: true

pages:
  stage: deploy
  rules:
    - if: '$CI_COMMIT_BRANCH == "branch/default"'
  script:
    - mkdir public
    - cp -vr doc/_build/html/* public/
  dependencies:
    - doc:build
  needs: ["doc:build"]
  artifacts:
    paths:
      - public


build:package:
  stage: build
  before_script:
    - pdm config cache_dir ${PDM_CACHE_DIR}
  script:
    - pdm build || pdm lock --group :all --refresh
  needs: []
  artifacts:
    when: always
    paths:
      - pdm.lock
      - dist
    expire_in: 24 hrs
  cache:
    when: always
    key: pdmcache-$CI_COMMIT_BRANCH
    paths:
      - ${PDM_CACHE_DIR}


# manually set PDM_PUBLISH_PASSWORD in web interface to your pypi API token
release:package:
  stage: release
  rules:
    - if: '$CI_MERGE_REQUEST_ID'
      when: never
    - if: '$CI_COMMIT_TAG'
      when: on_success
  variables:
    PDM_PUBLISH_USERNAME: __token__
  script:
    - pdm publish --no-build
  needs: [ "build:package" ]