.gitlab-ci.yml

default:
    image: python:3.14
    before_script:
        - uname -a
        - python -V  # Print out python version for debugging
        - apt-get update
        - git config --global user.email "cobib@cobib.org"
        - git config --global user.name "CoBib"
        - pip install virtualenv tox

# See https://docs.gitlab.com/ci/pipelines/merge_request_pipelines/
workflow:
  rules:
    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
    - if: $CI_COMMIT_TAG
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

# Change pip's cache directory to be inside the project directory since we can
# only cache local items.
variables:
  TERM: "linux"
  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
  GIT_SUBMODULE_STRATEGY: recursive
  GIT_SUBMODULE_FORCE_HTTPS: "true"
  PACKAGE_REGISTRY_URL: "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/${CI_PROJECT_NAME}"

# Pip's cache doesn't store the python packages
# https://pip.pypa.io/en/stable/reference/pip_install/#caching
#
# If you want to also cache the installed packages, you have to install
# them in a virtualenv and cache it as well.
cache:
    paths:
        - .cache/pip

stages:
    - lint
    - test
    - docs
    - deploy
    - publish

lint:
    stage: lint
    dependencies: []
    script:
        - tox -e lint -- --html-report htmlmypy --cobertura-xml-report .
        - head -1 cobertura.xml | awk -F'line-rate*=*\"' '{sub(/".*/,"",$2); printf "mypy coverage %.0f", $2 * 100; print "%"}'
    coverage: '/mypy coverage \d+%/'
    artifacts:
        when: always
        expire_in: 30 days
        paths:
            - cobertura.xml
            - htmlmypy
        reports:
          coverage_report:
            coverage_format: cobertura
            path: cobertura.xml

test:
    stage: test
    dependencies: []
    parallel:
        matrix:
            - PYTHON_VERSION: ['3.10', '3.11', '3.12', '3.13', '3.14']
    image: python:$PYTHON_VERSION
    script:
        - tox -e py$PYTHON_VERSION
    artifacts:
        when: always
        expire_in: 30 days
        paths:
            - tests/snapshot_report.html
            - tests/report-py$PYTHON_VERSION.xml
        reports:
            junit: tests/report-py$PYTHON_VERSION.xml
    rules:
        - if: $CI_MERGE_REQUEST_EVENT_TYPE == 'merge_train'
          when: on_success
        - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
          when: manual
          allow_failure: true
        - when: on_success

no-optionals:
    stage: test
    dependencies: []
    script:
        - tox -e no-optionals
    artifacts:
        when: always
        expire_in: 30 days
        paths:
            - tests/report-no-optionals.xml
            - tests/snapshot_report.html
        reports:
            junit: tests/report-no-optionals.xml

plugin:
    stage: test
    dependencies: []
    script:
        - tox -e plugin
    artifacts:
        when: always
        expire_in: 30 days
        paths:
            - plugin/report-plugin.xml
            - plugin/snapshot_report.html
        reports:
            junit: plugin/report-plugin.xml

coverage:
    stage: test
    dependencies: []
    script:
        - tox -e coverage
    coverage: '/TOTAL\s+\d+\s+\d+\s+(\d+\s+\d+\s+)*(\d+%)/'
    artifacts:
        when: always
        expire_in: 30 days
        paths:
            - coverage.xml
            - htmlcov
            - snapshot_report.html
        reports:
          coverage_report:
            coverage_format: cobertura
            path: coverage.xml

docs:
    stage: docs
    needs: []
    script:
        - apt-get install -y ruby-dev
        - gem install ronn-ng
        - tox -e docs
        - mv build/html public
    artifacts:
        paths:
          - public

dev-pages:
    stage: deploy
    needs: ["docs"]
    before_script: []
    script:
        - ls public
    environment:
        name: dev
        url: "https://$CI_PROJECT_NAMESPACE.gitlab.io/-/$CI_PROJECT_NAME/-/jobs/$CI_JOB_ID/artifacts/public/index.html"
    artifacts:
        paths:
            - public
    rules:
        - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
          when: on_success
        - when: never

mr-pages:
    stage: deploy
    needs: ["docs"]
    before_script: []
    script:
        - ls public
    environment:
        name: docs/$CI_COMMIT_REF_SLUG
        url: "https://$CI_PROJECT_NAMESPACE.gitlab.io/-/$CI_PROJECT_NAME/-/jobs/$CI_JOB_ID/artifacts/public/index.html"
        on_stop: stop-mr-pages
    artifacts:
        paths:
            - public
    rules:
        - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
          when: on_success
        - when: never

stop-mr-pages:
    stage: deploy
    needs:
        - job: mr-pages
          artifacts: false
    before_script: []
    script:
        - echo "Stopping docs preview environment"
    environment:
        name: docs/$CI_COMMIT_REF_SLUG
        action: stop
    rules:
        - if: $CI_MERGE_REQUEST_ID
          when: manual
          allow_failure: true
        - when: never

pages:
    stage: deploy
    needs: ["docs"]
    before_script: []
    script:
        - ls public
    artifacts:
        paths:
            - public
    rules:
        - if: $CI_COMMIT_TAG
          when: on_success
        - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
          when: manual
          allow_failure: true
        - when: never


build:
    stage: publish
    dependencies: []
    script:
        - pip install build
        - python -m build
    artifacts:
        paths:
            - dist/
    rules:
        - if: $CI_COMMIT_TAG
          when: on_success
        - when: never

archive:
    stage: publish
    needs:
        - job: build
          artifacts: false
    script:
        - git archive --format tar -o release.tar HEAD
        - git submodule --quiet foreach --recursive
          'git archive --format tar --prefix=$displaypath/ -o submodule.tar HEAD'
        - TOPDIR=$(pwd) git submodule --quiet foreach --recursive
          'cd $TOPDIR; tar --concatenate --file=release.tar $displaypath/submodule.tar; rm -fv $displaypath/submodule.tar'
        - gzip -9 release.tar
        - mv release.tar.gz "$CI_PROJECT_NAME-$CI_COMMIT_TAG.tar.gz"
    artifacts:
        paths:
            - $CI_PROJECT_NAME-$CI_COMMIT_TAG.tar.gz
    rules:
        - if: $CI_COMMIT_TAG
          when: on_success
        - when: never

publish-gitlab:
    stage: publish
    needs: ["archive"]
    script:
        - |
          curl --location --header "JOB-TOKEN: ${CI_JOB_TOKEN}" \
               --upload-file "$CI_PROJECT_NAME-$CI_COMMIT_TAG.tar.gz" \
               "${PACKAGE_REGISTRY_URL}/${CI_COMMIT_TAG}/${CI_PROJECT_NAME}-${CI_COMMIT_TAG}.tar.gz"
    rules:
        - if: $CI_COMMIT_TAG
          when: on_success
        - when: never

publish-pypi:
    stage: publish
    needs: ["build"]
    id_tokens:
      PYPI_ID_TOKEN:
          aud: pypi
    script:
        - pip install twine
        - twine upload dist/*
    environment:
        name: release
        url: https://pypi.org/p/cobib
    rules:
        - if: $CI_COMMIT_TAG
          when: on_success
        - when: never

release:
    stage: publish
    image: registry.gitlab.com/gitlab-org/cli:latest
    needs:
        - job: publish-gitlab
          artifacts: false
        - job: publish-pypi
          artifacts: false
    before_script:
        - echo "creating gitlab release"
    script:
        - echo "creating gitlab release"
    release:
        tag_name: '$CI_COMMIT_TAG'
        description: '$CI_COMMIT_TAG'
        assets:
            links:
                - name: "${CI_PROJECT_NAME}-${CI_COMMIT_TAG}.tar.gz"
                  url: "${PACKAGE_REGISTRY_URL}/${CI_COMMIT_TAG}/${CI_PROJECT_NAME}-${CI_COMMIT_TAG}.tar.gz"
                  filepath: "/${CI_PROJECT_NAME}-${CI_COMMIT_TAG}.tar.gz"
                  link_type: "package"
    rules:
        - if: $CI_COMMIT_TAG
          when: on_success
        - when: never