.gitlab-ci.yml

# SPDX-License-Identifier: FSFAP
# Copyright (C) 2019 John Hsu
# Copyright (C) 2019-2026 Colin B. Macdonald
# Copyright (C) 2021 Peter Lee
# Copyright (C) 2021 Morgan Arnold
# Copyright (C) 2022-2023 Edith Coates
# Copyright (C) 2023 Natalie Balashov
# Copyright (C) 2023 Julian Lapenna
# Copyright (C) 2023-2024 Andrew Rechnitzer
# Copyright (C) 2024 Aidan Murphy
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved.  This file is offered as-is,
# without any warranty.

# This the CI configuration for Plom Client

# Issue #1654: This stops multiple pipelines on merge-requests from forks
# But it seems to prevent forks from running their own CI jobs pre-MR
# include:
#   - template: 'Workflows/MergeRequest-Pipelines.gitlab-ci.yml'

# workflow:
#   rules:
#     - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
#     - if: '$CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS'
#       when: never
#     - if: '$CI_COMMIT_BRANCH'

image: docker:28.5.2

services:
  - docker:28.5.2-dind

variables:
  DOCKER_DRIVER: overlay2
  PLOM_NO_SSL_VERIFY: 1
  MACBIN_PY_MAJOR_MINOR_VER: "3.12"
  MACBIN_PY_VER: 3.12.9
  QT_QPA_PLATFORM: offscreen
  PYINSTALLER_VER: 6.16.0

stages:
  - static_analysis
  - build
  - test
  - packaging
  - prep
  - release


codespell:
  image: python:3
  stage: static_analysis
  before_script:
    - python3 -m pip install codespell~=2.4.2
  script:
    - echo "Need an exception?  See the .codespell-ignore* files"
    - codespell
  allow_failure: true
  artifacts:
    reports:
      dotenv: release_info.env


# sometimes we write everything twice: this job ensures dupe file/info stay same
wet_no_drift:
  stage: static_analysis
  image: alpine
  before_script:
    - apk add bash
  script:
    - echo "Version info duplicated in two places, ensure same"
    - export VER0=`sed -nr 's/^__version__ = \"(.+)\"/\1/p' plomclient/client/__init__.py`
    - export VER1=`sed -nr 's/^__version__ = \"(.+)\"/\1/p' plomclient/common.py`
    - export VER2=`sed -nr 's/^\s+version. (.+)/\1/p' AppImageBuilder.yml`
    - echo $VER0
    - echo $VER1
    - echo $VER2
    - bash -c "[[ x$VER0 == x$VER1 ]]"
    - bash -c "[[ x$VER0 == x$VER2 ]]"


# By default we assume the target is origin/main but if a MR is open,
# we try to determine the target branch and use that instead.
copyright_year:
  image: fedora:42
  stage: static_analysis
  rules:
    # Tags don't have this defined and non-empty. This job doesn't run on releases
    - if: $CI_COMMIT_BRANCH
  before_script:
    - dnf install -y python3 glab git
    - git --version
    - glab --version
    - echo $CI_COMMIT_TAG
    - echo $CI_COMMIT_BRANCH
    # Note that "upstream" is used as the local name for plom/plom-client
    - git remote add upstream https://gitlab.com/plom/plom-client.git
    - echo "Consider these various open merge requests"
    - glab mr list --source-branch=$CI_COMMIT_BRANCH --repo=plom/plom-client
    - read TARGET_REPO_NAME TARGET_BRANCH_NAME <<< $(./maint/find-MR-target-branch.py --source $CI_COMMIT_BRANCH --repo plom/plom-client --default "origin main")
    # we expect to find at most one MR
    - NUM_MRS=$(./maint/find-MR-target-branch.py --source $CI_COMMIT_BRANCH --repo plom/plom-client --default "origin main" | wc -l)
    - TARGET_BRANCH=${TARGET_REPO_NAME}/${TARGET_BRANCH_NAME}
    - echo "We think the target branch is '$TARGET_BRANCH'"
    - echo "Next ensure we have that target branch for comparing"
    # TODO: trying without --depth=1000
    - git fetch ${TARGET_REPO_NAME} ${TARGET_BRANCH_NAME}
    - git checkout ${TARGET_BRANCH}
    # TODO: what is these are the same branch?
    - git checkout $CI_COMMIT_BRANCH -- || true
    - git branch -avv
  script:
    - echo "Considering the following commits to this branch (since '${TARGET_BRANCH}'):"
    - git shortlog ${TARGET_BRANCH}..${CI_COMMIT_BRANCH} --
    - echo "Those commits touch the following files:"
    # git show --pretty="" --name-only ${TARGET_BRANCH}..${CI_COMMIT_BRANCH} -- | uniq -u
    - git diff --name-only ${TARGET_BRANCH}...${CI_COMMIT_BRANCH} --
    - ./maint/is-copyright-uptodate.py `git diff --name-only ${TARGET_BRANCH}...$CI_COMMIT_BRANCH --`
    - echo "Note that there are some files that do not have/need copyright headers"
    - if [ ${NUM_MRS} -gt 1 ]; then echo "'NUM_MRS' ('${NUM_MRS}' is greater than 1, exiting...)"; exit 1; fi
  allow_failure: true


# modules (__init__ and __main__) should show current year in copyright
copyright_visible:
  image: fedora
  stage: static_analysis
  script:
    - YEAR=`date +"%Y"`
    - echo $YEAR
    - echo "Each new year, must bump some copyright notices"
    - grep "&copy; ....-${YEAR}" plomclient/client/about_dialog.py
    - grep "__copyright__ = \"Copyright (C) ....-${YEAR}" plomclient/client/__init__.py
    - grep "__copyright__ = \"Copyright (C) ....-${YEAR}" plomclient/client/__main__.py
    - grep "__copyright__ = \"Copyright (C) ....-${YEAR}" plomclient/client/randoIDer.py
    - grep "__copyright__ = \"Copyright (C) ....-${YEAR}" plomclient/client/randoMarker.py


# to ensure the pypi job works, make sure we can package
# TODO: we make these again during pypi push: better to use these artifacts?
build-package:
  image: python:3
  stage: build
  script:
    - pip install --upgrade build
    - python3 -m build
    - ls dist
    - md5sum dist/*
    # mv dist dist_TODO
  artifacts:
    paths:
      # dist_TODO/plom*.tar.gz
      # dist_TODO/plom*.whl
      - dist/
    expire_in: 16 days


# If we have a tag, then push to PyPI using OIDC, no TWINE_* env vars
# https://docs.pypi.org/trusted-publishers/using-a-publisher/#gitlab-cicd
pypi-publish:
  image: python:3
  stage: packaging
  dependencies:
    - build-package
  rules:
   - if: $CI_COMMIT_TAG
  cache: {}
  id_tokens:
    PYPI_ID_TOKEN:
      aud: pypi
  script:
    - apt update && apt install -y jq
    - pip install --upgrade twine id
    # pip install --upgrade wheel setuptools packaging build
    # python3 -m build
    - ls dist
    - pushd dist
    - md5sum *
    - sha256sum *
    - popd

    # Retrieve the OIDC token from GitLab CI/CD, and exchange it for a PyPI API token
    - oidc_token=$(python -m id pypi)
    - resp=$(curl -X POST https://pypi.org/_/oidc/mint-token -d "{\"token\":\"${oidc_token}\"}")
    - api_token=$(jq --raw-output '.token' <<< "${resp}")

    # Upload to PyPI authenticating via the newly-minted token
    - twine upload -u __token__ -p ${api_token} --verbose dist/*


release_job:
  stage: release
  image: registry.gitlab.com/gitlab-org/release-cli:latest
  rules:
    - if: $CI_COMMIT_TAG
  script:
    - echo 'running release_job'
    - echo "Draft of release notes follows (newlines eaten)"
    - cat release_desc.md
    - echo "Just debugging:"
    - echo $LINKNAME0
    - echo $URL0
    - echo $FILENAME0
    - echo $LINKNAME1
    - echo $URL1
    - echo $FILENAME1
    - echo $LINKNAME2
    - echo $URL2
    - echo $FILENAME2
    - echo $LINKNAME3
    - echo $URL3
    - echo $FILENAME4
  release:
    name: 'Release $CI_COMMIT_TAG'
    description: './release_desc.md'
    tag_name: '$CI_COMMIT_TAG'
    ref: '$CI_COMMIT_TAG'
    milestones:
      # ${CI_COMMIT_TAG:1} might strip the leading v
      - $CI_COMMIT_TAG
    assets:
      links:
        - name: $LINKNAME0
          filepath: "/$FILENAME0"
          url: $URL0
          link_type: "package"
        - name: $LINKNAME1
          filepath: "/$FILENAME1"
          url: $URL1
          link_type: "package"
        - name: $LINKNAME2
          filepath: "/$FILENAME2"
          url: $URL2
          link_type: "package"
        - name: $LINKNAME3
          filepath: "/$FILENAME3"
          url: $URL3
          link_type: "package"
        - name: $OTHER_LINKNAME1
          url: $OTHER_URL1
          link_type: "other"
        - name: $OTHER_LINKNAME2
          url: $OTHER_URL2
          link_type: "other"
        - name: $OTHER_LINKNAME3
          url: $OTHER_URL3
          link_type: "other"


# block release unless tag matches in-source version
tag_matches_ver:
  stage: static_analysis
  image: python:3
  rules:
   - if: $CI_COMMIT_TAG
  script:
    - export VER=`sed -nr 's/^__version__ = \"(.+)\"/\1/p' plomclient/client/__init__.py`
    - echo "Extracted version string '$VER'"
    - echo "Now comparing to CI_COMMIT_TAG '$CI_COMMIT_TAG'"
    - echo $VER
    - echo $CI_COMMIT_TAG
    # note reversed logic and extra "v"
    - python3 -c "exit(not 'v$VER' == '$CI_COMMIT_TAG')"


# Should keep version same or close to that in .pre-commit-config.yaml
black:
  stage: static_analysis
  image: python:3.12
  before_script:
    - pip3 install "black~=25.12.0"
  script:
    - black --check --diff .
  allow_failure: true


# image: python:3.12?
unittests:
  stage: test
  needs: []
  image: ubuntu:24.04
  before_script:
    - apt-get -y update
    - DEBIAN_FRONTEND=noninteractive apt-get -y install tzdata
    - apt-get --no-install-recommends -y install
      libpango-1.0-0 libpangocairo-1.0-0
      python3
      python3-pip
      python3-setuptools
      python3-wheel
      python3-pytest python3-pytestqt
      python3-pyqt6 python3-pyqt6.qtsvg pyqt6-dev-tools
      python3-platformdirs python3-packaging python3-requests-toolbelt
      python3-tomlkit python3-arrow
      python3-pillow
    - apt-get -yq autoclean
    - pip install --break-system-packages pyspellchecker stdiomask
  script:
    - pytest --version
    - pytest -l --pyargs plomclient
    # TODO how to run only doctests?  here we just ignore-glib on "test_*"
    # pip install --upgrade pytest
    - pytest --version
    - pytest -l --doctest-modules --doctest-continue-on-failure --ignore-glob="*/test_*.py" plomclient



# TODO: from the Containerfile, maybe Ubuntu 22.04 needs this?
# apt-get --no-install-recommends -y install libglib2.0-0 libgl1-mesa-glx \
#     libegl1 libxkbcommon0 libdbus-1-3 && \
coverage:
  stage: test
  needs: []
  image: ubuntu:24.04
  before_script:
    - apt-get -y update
    - DEBIAN_FRONTEND=noninteractive apt-get -y install tzdata
    - apt-get --no-install-recommends -y install
      libpango-1.0-0 libpangocairo-1.0-0
      python3
      python3-dev
      python3-pip
      python3-setuptools
      python3-wheel
      python3-pytest python3-pytestqt
      python3-pyqt6 python3-pyqt6.qtsvg pyqt6-dev-tools
      python3-platformdirs python3-packaging python3-requests-toolbelt
      python3-tomlkit python3-arrow
      python3-pillow
    - apt-get -yq autoclean
    - pip install --break-system-packages pyspellchecker stdiomask
  script:
    - pip install --break-system-packages pytest pytest-cov coverage[toml]~=7.13.4
    - coverage run -m pytest
    - coverage report --precision=2
    - coverage xml
  coverage: '/^TOTAL\s+.*\s(\d+\.\d+)%$/'
  artifacts:
    reports:
      coverage_report:
        coverage_format: cobertura
        path: coverage.xml


# needs full dependencies, cannot easily run with other early static analysis
pylint:
  stage: test
  needs: []
  image: ubuntu:24.04
  before_script:
    - apt-get -y update
    - DEBIAN_FRONTEND=noninteractive apt-get -y install tzdata
    - apt-get --no-install-recommends -y install
      libpango-1.0-0 libpangocairo-1.0-0
      python3
      python3-pip
      python3-setuptools
      python3-wheel
      python3-pytest python3-pytestqt
      python3-pyqt6 python3-pyqt6.qtsvg pyqt6-dev-tools
      python3-platformdirs python3-packaging python3-requests-toolbelt
      python3-tomlkit python3-arrow
      python3-pillow
    - apt-get -yq autoclean
    - pip install --break-system-packages pyspellchecker stdiomask
    - pip install --break-system-packages astroid~=4.1.1  # codespell:ignore astroid
    - pip install --break-system-packages pylint~=4.0.5
  script:
    - pylint plomclient
  allow_failure: true


# needs full dependencies, cannot easily run with other early static analysis
# If exceptions are needed, see "tool.mypy" sections in pyproject.toml
mypy-type-checking:
  stage: test
  needs: []
  image: ubuntu:24.04
  before_script:
    - apt-get -y update
    - DEBIAN_FRONTEND=noninteractive apt-get -y install tzdata
    - apt-get --no-install-recommends -y install
      libpango-1.0-0 libpangocairo-1.0-0
      python3
      python3-pip
      python3-setuptools
      python3-wheel
      python3-pytest python3-pytestqt
      python3-pyqt6 python3-pyqt6.qtsvg pyqt6-dev-tools
      python3-platformdirs python3-packaging python3-requests-toolbelt
      python3-tomlkit python3-arrow
      python3-pillow
    - apt-get -y install python3-tomli  # else mypy fails, unsure why as Python 3.12
    - apt-get -yq autoclean
    - pip install --break-system-packages pyspellchecker stdiomask
    # mypy was failing with the Ubuntu built-in one
    - pip install --break-system-packages -U pillow
    # mypy 1.17.x cannot check against Python 3.8 code
    - pip install --break-system-packages mypy~=1.16.1
  script:
    - mypy --version
    - export PIP_BREAK_SYSTEM_PACKAGES=1
    - mypy plomclient --python-ver 3.8 --install-types --non-interactive || true
    - mypy plomclient --python-ver 3.8
  allow_failure: true


pyright:
  stage: test
  needs: []
  image: ubuntu:24.04
  before_script:
    - apt-get -y update
    - DEBIAN_FRONTEND=noninteractive apt-get -y install tzdata
    - apt-get --no-install-recommends -y install
      libpango-1.0-0 libpangocairo-1.0-0
      python3
      python3-pip
      python3-setuptools
      python3-wheel
      python3-pytest python3-pytestqt
      python3-pyqt6 python3-pyqt6.qtsvg pyqt6-dev-tools
      python3-platformdirs python3-packaging python3-requests-toolbelt
      python3-tomlkit python3-arrow
      python3-pillow
    - apt-get -yq autoclean
    - pip install --break-system-packages pyspellchecker stdiomask
    - pip install --break-system-packages pyright~=1.1.407
  script:
    # for now, just display errors but don't fail (Issue #3237)
    - pyright || true
  allow_failure: true


flake8:
  image: python:3
  stage: static_analysis
  before_script:
    - python3 -m pip install flake8~=7.3.0
  script:
    # first show all errors and warnings but don't fail
    - flake8 --exit-zero
    - flake8


# TODO: does this fully replace flake8?
# TODO: `ruff format` seems not completely compatible with black
ruff:
  image: python:3
  stage: static_analysis
  before_script:
    - python3 -m pip install ruff~=0.15.5
  script:
    - ruff check .
    # ruff format .


# Note: $EXCEPTIONS matches an ignore list in pyproject.toml
count-no-docstring:
  image: python:3
  stage: static_analysis
  before_script:
    - python3 -m pip install ruff~=0.15.5
  script:
    # run once just for log out but don't fail
    - EXCEPTIONS="D101,D102,D103,D104,D106"
    - ruff check --select $EXCEPTIONS --exit-zero
    - HOWMANY=`ruff check --select $EXCEPTIONS --exit-zero | grep "Found .* errors" | grep -o "[0-9]*"`
    - echo $EXCEPTIONS
    - ruff check --select $EXCEPTIONS --statistics --exit-zero
    - echo "Total $HOWMANY things without docstrings, please don't increase it"
    # Dear hackers: please try to decrease this number
    - bash -c "[[ $HOWMANY -le 402 ]]"
  allow_failure: true


appstream-valid:
  stage: static_analysis
  image: alpine
  before_script:
    - apk add appstream
    - apk add appstream-glib
  script:
    - appstream-util --version || true
    - appstream-util validate org.plomgrading.PlomClient.metainfo.xml
    - appstreamcli --version
    # TODO: consider adding --strict on 0.16.4 which supports <developer> tag
    - appstreamcli validate --pedantic --explain org.plomgrading.PlomClient.metainfo.xml


# get latest pip deps, doesn't use docker, closer to user install
# allowed to fail (some pip stuff might be new) but we want to know
newOS_newdeps_legacy:
  stage: test
  image: ubuntu:22.04
  allow_failure: true
  before_script:
    - apt-get update
    - DEBIAN_FRONTEND=noninteractive apt-get install -y tzdata curl
    - apt-get --no-install-recommends --yes install
      make g++ imagemagick
      libgl1-mesa-glx libsm6 libxrender1 libegl1 libxkbcommon0 libdbus-1-3
      libxcb-cursor0 libpango-1.0-0 libpangocairo-1.0-0
      python3-pytest python3-dev
      python3-pip
      iproute2 psmisc file
    # apt-get --no-install-recommends --yes install libimage-exiftool-perl
    - python3 -m pip install --upgrade pip setuptools packaging wheel
    - pip --version
  script:
    - pip install .
    # First, run the unit tests
    - pytest-3 -l --pyargs plomclient


# Ensure minimum listed dependency versions actually work on older system
# 1. oldest reasonably supported popular OS
# 2. take python deps from package manager
# 3. force the minimum version from setup.py
# Goal here is to catch changes that need newer features of a dependency.
oldOS_mindeps:
  stage: test
  image: ubuntu:20.04
  before_script:
    - apt-get update
    - DEBIAN_FRONTEND=noninteractive apt-get install -y tzdata curl
    - apt-get --no-install-recommends --yes install
      make g++ imagemagick
      libgl1-mesa-glx libsm6 libxrender1 libegl1 libxkbcommon0 libdbus-1-3
      libpango-1.0-0 libpangocairo-1.0-0
      python3 python3-dev
      python3-pip python3-setuptools python3-wheel
      python3-requests-toolbelt python3-pil
      python3-defusedxml python3-jsmin python3-packaging
      iproute2 psmisc file
    # TODO: is it possible to run with OOTB pip etc?
    - python3 -m pip install --upgrade pip setuptools packaging wheel
    - python3 -m pip --version
  script:
    - python3 -m pip install -r requirements.txt.tempminima
    - python3 -m pip install .
    # First, run the unit tests
    - pytest -l --pyargs plomclient


# Minimum Python, minimum deps
minpy_mindeps:
  stage: test
  image: python:3.8
  before_script:
    - apt-get update
    - apt-get --no-install-recommends --yes install
      make imagemagick g++
      libgl1-mesa-glx libsm6 libxrender1 libegl1 libxkbcommon0 libdbus-1-3
    - pip install pytest
  script:
    - pip install -r requirements.txt.tempminima
    - pip install .
    - pytest -l --pyargs plomclient


# upload binaries are generic gitlab packages
binary_upload:
  stage: prep
  image: curlimages/curl:latest
  rules:
   - if: $CI_COMMIT_TAG
  script:
    - ls
    - md5sum PlomClient*
    - |
      tee release_desc.md <<EOF
      ## Installation instructions

      Please see [plomgrading.org](https://plomgrading.org).
      If you're here looking for Clients, see "Plom Client" packages above.

      #### macOS versions

      We build binaries for macOS using macOS 14.  They might also work on macOS 13.
      Users of older versions of macOS will need to upgrade their OS.

      #### Changes in this release

      See [the Changelog](https://gitlab.com/plom/plom-client/-/blob/$CI_COMMIT_TAG/CHANGELOG.md).


      EOF
    # strip the leading v in v0.x.y: don't see how to do this without dotenv
    - export VER=${CI_COMMIT_TAG:1}
    - echo $VER
    - export LINKNAME0="Plom Client for GNU/Linux (AppImage)"
    - export LINKNAME1="Plom Client for Windows (Windows ≥ 10, x86-64)"
    - export LINKNAME2="Plom Client for older Mac (x86_64, macOS ≥ 14)"
    - export LINKNAME3="Plom Client for newer Mac (arm64, macOS ≥ 14)"
    - export FILENAME0="PlomClient-$VER-x86_64.AppImage"
    - export FILENAME1="PlomClient-$VER.exe"
    - export FILENAME2="PlomClient-$VER-macos14-x86_64.zip"
    - export FILENAME3="PlomClient-$VER-macos14-arm64.zip"
    - echo "#### artifact md5 hashes" >> "release_desc.md"
    - echo "" >> "release_desc.md"
    - md5sum dist/plom*.tar.gz | sed -e "s/^/    /" | sed -e "s/dist\///" >> "release_desc.md"
    - md5sum $FILENAME0 | sed -e "s/^/    /" >> "release_desc.md"
    - md5sum $FILENAME1 | sed -e "s/^/    /" >> "release_desc.md"
    - md5sum $FILENAME2 | sed -e "s/^/    /" >> "release_desc.md"
    - md5sum $FILENAME3 | sed -e "s/^/    /" >> "release_desc.md"
    - echo "" >> "release_desc.md"
    - echo "" >> "release_desc.md"
    - echo "#### artifact sha256 hashes" >> "release_desc.md"
    - echo "" >> "release_desc.md"
    - sha256sum dist/plom*.tar.gz | sed -e "s/^/    /" | sed -e "s/dist\///" >> "release_desc.md"
    - sha256sum $FILENAME0 | sed -e "s/^/    /" >> "release_desc.md"
    - sha256sum $FILENAME1 | sed -e "s/^/    /" >> "release_desc.md"
    - sha256sum $FILENAME2 | sed -e "s/^/    /" >> "release_desc.md"
    - sha256sum $FILENAME3 | sed -e "s/^/    /" >> "release_desc.md"
    - export URL0="${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/PlomClient-linux/$VER/$FILENAME0"
    - export URL1="${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/PlomClient-windows/$VER/$FILENAME1"
    - export URL2="${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/PlomClient-macos/$VER/$FILENAME2"
    - export URL3="${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/PlomClient-macos/$VER/$FILENAME3"
    - export OTHER_URL1="https://pypi.org/project/plom-client"
    - export OTHER_URL2="https://flathub.org/apps/details/org.plomgrading.PlomClient"
    - export OTHER_URL3="https://hub.docker.com/r/plomgrading/server"
    - export OTHER_LINKNAME1="Find Plom Client on PyPI"
    - export OTHER_LINKNAME2="Install Plom Client from Flathub (GNU/Linux)"
    - export OTHER_LINKNAME3="Plom Server on DockerHub"
    - echo "OTHER_URL1=$OTHER_URL1" >> release_info.env
    - echo "OTHER_URL2=$OTHER_URL2" >> release_info.env
    - echo "OTHER_URL3=$OTHER_URL3" >> release_info.env
    - echo "OTHER_LINKNAME1=$OTHER_LINKNAME1" >> release_info.env
    - echo "OTHER_LINKNAME2=$OTHER_LINKNAME2" >> release_info.env
    - echo "OTHER_LINKNAME3=$OTHER_LINKNAME3" >> release_info.env
    - echo "LINKNAME0=$LINKNAME0" >> release_info.env
    - echo "LINKNAME1=$LINKNAME1" >> release_info.env
    - echo "LINKNAME2=$LINKNAME2" >> release_info.env
    - echo "LINKNAME3=$LINKNAME3" >> release_info.env
    - echo "URL0=$URL0" >> release_info.env
    - echo "URL1=$URL1" >> release_info.env
    - echo "URL2=$URL2" >> release_info.env
    - echo "URL3=$URL3" >> release_info.env
    - echo "FILENAME0=$FILENAME0" >> release_info.env
    - echo "FILENAME1=$FILENAME1" >> release_info.env
    - echo "FILENAME2=$FILENAME2" >> release_info.env
    - echo "FILENAME3=$FILENAME3" >> release_info.env
    # actually do the uploads
    - |
      curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file $FILENAME0 "$URL0"
    - |
      curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file $FILENAME1 "$URL1"
    - |
      curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file $FILENAME2 "$URL2"
    - |
      curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file $FILENAME3 "$URL3"
    - cat release_desc.md
  artifacts:
    paths:
      - release_desc.md
    reports:
      dotenv: release_info.env
    expire_in: 16 days


# Build Client Binaries
# These are run once tests pass: to change re-add `needs: []`
linux_client_appimage:
  stage: packaging
  script:
    - docker build --tag appimagebuilder_tmp -f AppImageBuilder.Containerfile .
    - docker create -ti --name dummy appimagebuilder_tmp bash
    - export VER=`sed -nr 's/^__version__ = \"(.+)\"/\1/p' plomclient/client/__init__.py`
    - export NAME=PlomClient-$VER-x86_64.AppImage
    - docker cp dummy:/app/$NAME .
    - docker rm -f dummy
    - md5sum $NAME > md5sum
    - ls $NAME
    - cat md5sum
  artifacts:
    paths:
    - PlomClient*.AppImage
    - md5sum
    expire_in: 16 days


# TODO: broken by the upgrade to PyQt6, currently set to manual
linuxbin_ubuntu2004:
  stage: packaging
  when: manual
  allow_failure: true
  image: ubuntu:20.04
  before_script:
    - apt-get update
    - DEBIAN_FRONTEND=noninteractive apt-get install -y tzdata curl
    - apt-get --no-install-recommends --yes install iproute2 psmisc file binutils
      python3 python3-dev python3-wheel python3-setuptools python3-pip
    - apt-get install -y libglib2.0 libgl1-mesa-glx libsm6 libxrender1 libegl1 libxkbcommon0 libdbus-1-3 libxcb-cursor0
    - pip install --upgrade pip
    - pip install pyinstaller~=$PYINSTALLER_VER
  script:
    - pip install -r requirements.txt
    - pyinstaller client.linux.spec
    - export VER=$(python3 -c "from plomclient.client import __version__; print(__version__)")
    - echo "Extracted version string '$VER'"
    - export NAME=PlomClient-$VER-linux-ubuntu2004.bin
    - mv dist/PlomClient*.bin $NAME
    - chmod 755 $NAME
    - md5sum $NAME > md5sum
    - ls $NAME
    - cat md5sum
  artifacts:
    paths:
    - PlomClient*.bin
    - md5sum
    expire_in: 16 days


linuxbin_ubuntu2204:
  stage: packaging
  image: ubuntu:22.04
  before_script:
    - apt-get update
    - DEBIAN_FRONTEND=noninteractive apt-get install -y tzdata curl
    - apt-get --no-install-recommends --yes install iproute2 psmisc file binutils
      python3 python3-dev python3-wheel python3-setuptools python3-pip
    - apt-get --yes install
      libglib2.0-0
      libxkbcommon0 libgl1 libegl1
      libgl1-mesa-glx libsm6 libxrender1 libdbus-1-3
      libxcb-cursor0 libpango-1.0-0 libpangocairo-1.0-0
    - pip install --upgrade pip
    - pip install pyinstaller~=$PYINSTALLER_VER
    - pip install . --no-deps  # pyinstaller spec needs version
  script:
    - pip install -r requirements.txt
    - pyinstaller client.linux.spec
    - export VER=$(python3 -c "from plomclient.client import __version__; print(__version__)")
    - echo "Extracted version string '$VER'"
    # ensure its not empty
    - if [[ -z "$VER" ]]; then exit 1; fi
    - export NAME=PlomClient-$VER-linux-ubuntu2204.bin
    - mv dist/PlomClient*.bin $NAME
    - chmod 755 $NAME
    - md5sum $NAME > md5sum
    - ls $NAME
    - cat md5sum
  artifacts:
    paths:
    - PlomClient*.bin
    - md5sum
    expire_in: 16 days


# Notes on macOS client builds
# - June 2023, we now have only M1 (arm64) runners:
#     - goal remains universal2 binary: Issue #1655
#     - for now, we use Rosetta2 to cross compile onto x86_64
# - Aug 2021, based on https://github.com/danhper/asdf-python/issues/38 we used:
#     - PYTHON_CONFIGURE_OPTS="--enable-framework" asdf install python $MACBIN_PY_VER
#   Not sure what this was for but it broke in 2023-Jan (Issue #2478).  I tried:
#   "--enable-framework=/Users/gitlab/.asdf/installs/Library/Frameworks" asdf ...
#   Also "--enable-shared", but it seems to work without any of these things?
# - macOS <= 10.14: older asdf, use `asdf local` not `asdf shell`
# - to get hardcoded path: verbose `pip install -v -v pyinstaller`
macos14_universal_client:
  image: macos-14-xcode-15
  tags:
  - saas-macos-medium-m1
  rules:
  - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
    when: never
  - if: $CI_PROJECT_PATH == "plom/plom-client"
    when: manual
  allow_failure: true
  stage: packaging
  needs: []
  variables:
    HOMEBREW_NO_AUTO_UPDATE: 1
    HOMEBREW_NO_INSTALL_CLEANUP: 1
    HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: 1
    MINIMUM_MACOS_VER: 14
  script:
  - pwd
  - sw_vers
  - uname -a
  - uname -m
  - echo $SHELL
  - which python
  - python --version
  - pip --version
  - uname -m
  - arch -x86_64 uname -m
  - brew --version
  - brew install ninja
  - brew install numpy
  # quite likely the built-in python would work...  but below we install latest
  - arch -x86_64 /usr/bin/python3 --version
  - arch -arm64 /usr/bin/python3 --version
  - /usr/bin/python3 -m pip --version
  # install specific python
  - curl https://www.python.org/ftp/python/$MACBIN_PY_VER/python-$MACBIN_PY_VER-macos11.pkg --output python.pkg
  - sudo installer -pkg python.pkg -target /
  - python3 --version
  - /usr/bin/python3 --version
  - /usr/local/bin/python3 --version
  - arch -x86_64 /usr/local/bin/python3 --version
  - /usr/local/bin/python3 -m pip install --upgrade pip
  - which pip
  - which pip3
  - pip --version
  # hacks for charset_normalizer, following https://github.com/machawk1/wail/pull/562/
  - arch -x86_64 /usr/local/bin/python3 -m pip install "charset_normalizer<3.0"
  # /usr/local/bin/python3 -m pip install "charset_normalizer<3.0"
  # arch -x86_64 /usr/local/bin/python3 -m pip install Pillow --no-binaries
  # numpy fails complaining about blas, try from brew instead?
  # /usr/local/bin/python3 -m pip install numpy --no-binary ":all:"
  - /usr/local/bin/python3 -m pip install Pillow --no-binary ":all:"
  - /usr/local/bin/python3 -m pip install -r requirements.txt
  - arch -x86_64 /usr/local/bin/python3 -m pip install -r requirements.txt
  - /usr/local/bin/python3 -m pip install pyinstaller~=$PYINSTALLER_VER
  - /usr/local/bin/python3 -m pip install . --no-deps  # pyinstaller spec needs version
  - /Library/Frameworks/Python.framework/Versions/${MACBIN_PY_MAJOR_MINOR_VER}/bin/pyinstaller client.macos-universal2.spec
  - ls dist/
  - export VER=`sed -nr 's/^__version__ = \"(.+)\"/\1/p' plomclient/client/__init__.py`
  - echo "Extracted version string '$VER'"
  # ensure its not empty
  - if [[ -z "$VER" ]]; then exit 1; fi
  - export ZIPNAME=PlomClient-$VER-macos14.zip
  - pushd dist
  - ls
  - ls -sklR PlomClient-$VER-universal2.app
  - zip -r $ZIPNAME PlomClient-$VER.app
  - popd
  - mv dist/$ZIPNAME $ZIPNAME
  - md5 $ZIPNAME > md5sum
  - ls $ZIPNAME
  - cat md5sum
  artifacts:
    paths:
    - PlomClient*.zip
    - md5sum
    expire_in: 16 days


macos14_arm64_client:
  image: macos-14-xcode-15
  tags:
  - saas-macos-medium-m1
  rules:
  - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
    when: never
  - if: $CI_PROJECT_PATH == "plom/plom-client"
  stage: packaging
  variables:
    # Maybe it works on macOS 13...?
    MINIMUM_MACOS_VER: 13
  script:
  - pwd
  - sw_vers
  - uname -a
  - uname -m
  - echo $SHELL
  - which python
  - python --version
  - pip --version
  - uname -m
  - /usr/bin/python3 -m pip --version
  - curl https://www.python.org/ftp/python/$MACBIN_PY_VER/python-$MACBIN_PY_VER-macos11.pkg --output python.pkg
  - sudo installer -pkg python.pkg -target /
  - python3 --version
  - /usr/bin/python3 --version
  - /usr/local/bin/python3 --version
  - /usr/local/bin/python3 -m pip install --upgrade pip
  - /usr/local/bin/python3 -m pip install -r requirements.txt
  - /usr/local/bin/python3 -m pip install pyinstaller~=$PYINSTALLER_VER
  - /usr/local/bin/python3 -m pip install . --no-deps  # pyinstaller spec needs version
  - /Library/Frameworks/Python.framework/Versions/${MACBIN_PY_MAJOR_MINOR_VER}/bin/pyinstaller client.macos.spec
  - ls dist/
  - export VER=`sed -nr 's/^__version__ = \"(.+)\"/\1/p' plomclient/client/__init__.py`
  - echo "Extracted version string '$VER'"
  # ensure its not empty
  - if [[ -z "$VER" ]]; then exit 1; fi
  - export ZIPNAME=PlomClient-$VER-macos14-arm64.zip
  - pushd dist
  - ls
  - ls -sklR PlomClient-$VER-arm64.app
  - zip -r $ZIPNAME PlomClient-$VER-arm64.app
  - popd
  - mv dist/$ZIPNAME $ZIPNAME
  - md5 $ZIPNAME > md5sum
  - ls $ZIPNAME
  - cat md5sum
  artifacts:
    paths:
    - PlomClient*.zip
    - md5sum
    expire_in: 16 days


macos14_x86_64_client:
  image: macos-14-xcode-15
  tags:
  - saas-macos-medium-m1
  rules:
  - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
    when: never
  - if: $CI_PROJECT_PATH == "plom/plom-client"
  stage: packaging
  variables:
    # 2025-10-07: Colin tested on x86_64 macOS 13.7.4.
    MINIMUM_MACOS_VER: 13
  script:
  - pwd
  - sw_vers
  - uname -a
  - uname -m
  - echo $SHELL
  - which python
  - python --version
  - pip --version
  - uname -m
  - arch -x86_64 uname -m
  # quite likely the built-in python would work...  but below we install latest
  - arch -x86_64 /usr/bin/python3 --version
  # install specific python
  - curl https://www.python.org/ftp/python/$MACBIN_PY_VER/python-$MACBIN_PY_VER-macos11.pkg --output python.pkg
  - sudo installer -pkg python.pkg -target /
  - python3 --version
  - /usr/bin/python3 --version
  - /usr/local/bin/python3 --version
  - arch -x86_64 /usr/local/bin/python3 --version
  - arch -x86_64 /usr/local/bin/python3 -m pip install --upgrade pip
  # hacks for charset_normalizer, following https://github.com/machawk1/wail/pull/562/
  - arch -x86_64 /usr/local/bin/python3 -m pip install "charset_normalizer<3.0"
  - arch -x86_64 /usr/local/bin/python3 -m pip install -r requirements.txt
  - arch -x86_64 /usr/local/bin/python3 -m pip install pyinstaller~=$PYINSTALLER_VER
  - arch -x86_64 /usr/local/bin/python3 -m pip install . --no-deps  # pyinstaller spec needs version
  - arch -x86_64 /Library/Frameworks/Python.framework/Versions/${MACBIN_PY_MAJOR_MINOR_VER}/bin/pyinstaller client.macos-x86_64.spec
  - ls dist/
  - export VER=`sed -nr 's/^__version__ = \"(.+)\"/\1/p' plomclient/client/__init__.py`
  - echo "Extracted version string '$VER'"
  # ensure its not empty
  - if [[ -z "$VER" ]]; then exit 1; fi
  - export ZIPNAME=PlomClient-$VER-macos14-x86_64.zip
  - pushd dist
  - ls
  - ls -sklR PlomClient-$VER-x86_64.app
  - zip -r $ZIPNAME PlomClient-$VER-x86_64.app
  - popd
  - mv dist/$ZIPNAME $ZIPNAME
  - md5 $ZIPNAME > md5sum
  - ls $ZIPNAME
  - cat md5sum
  artifacts:
    paths:
    - PlomClient*.zip
    - md5sum
    expire_in: 16 days


macos15_arm64_client:
  image: macos-15-xcode-16
  tags:
  - saas-macos-medium-m1
  rules:
  - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
    when: never
  - if: $CI_PROJECT_PATH == "plom/plom-client"
  stage: packaging
  variables:
    MINIMUM_MACOS_VER: 15
  script:
  - pwd
  - sw_vers
  - uname -a
  - uname -m
  - echo $SHELL
  - which python
  - python --version
  - pip --version
  - uname -m
  - /usr/bin/python3 -m pip --version
  - curl https://www.python.org/ftp/python/$MACBIN_PY_VER/python-$MACBIN_PY_VER-macos11.pkg --output python.pkg
  - sudo installer -pkg python.pkg -target /
  - python3 --version
  - /usr/bin/python3 --version
  - /usr/local/bin/python3 --version
  - /usr/local/bin/python3 -m pip install --upgrade pip
  - /usr/local/bin/python3 -m pip install -r requirements.txt
  - /usr/local/bin/python3 -m pip install pyinstaller~=$PYINSTALLER_VER
  - /usr/local/bin/python3 -m pip install . --no-deps  # pyinstaller spec needs version
  - /Library/Frameworks/Python.framework/Versions/${MACBIN_PY_MAJOR_MINOR_VER}/bin/pyinstaller client.macos.spec
  - ls dist/
  - export VER=`sed -nr 's/^__version__ = \"(.+)\"/\1/p' plomclient/client/__init__.py`
  - echo "Extracted version string '$VER'"
  # ensure its not empty
  - if [[ -z "$VER" ]]; then exit 1; fi
  - export ZIPNAME=PlomClient-$VER-macos15-arm64.zip
  - pushd dist
  - ls
  - ls -sklR PlomClient-$VER-arm64.app
  - zip -r $ZIPNAME PlomClient-$VER-arm64.app
  - popd
  - mv dist/$ZIPNAME $ZIPNAME
  - md5 $ZIPNAME > md5sum
  - ls $ZIPNAME
  - cat md5sum
  artifacts:
    paths:
    - PlomClient*.zip
    - md5sum
    expire_in: 16 days


# Build Windows client binaries
# This section written in PowerShell
windows-client:
  tags:
  - saas-windows-medium-amd64
  stage: packaging
  before_script:
  - choco install -y python312
  - Import-Module $env:ChocolateyInstall\helpers\chocolateyProfile.psm1
  - refreshenv
  - c:\python312\python -m pip --version
  - c:\python312\python -m pip install --user --upgrade pip
  - c:\python312\python -m pip --version
  - c:\python312\python -m pip install --user --upgrade setuptools packaging wheel
  - refreshenv
  script:
  - c:\python312\python -m pip install -r requirements.txt
  - refreshenv
  # Delay pyinstaller for a month or so, sometimes output flagged as virus (Issue #1353)
  - c:\python312\python -m pip install pyinstaller~=$PYINSTALLER_VER
  - refreshenv
  - c:\python312\python -m pip install . --no-deps  # pyinstaller spec needs version
  - refreshenv
  - c:\python312\python -m plomclient.client -h
  - c:\python312\scripts\pyinstaller client.windows.spec
  - $VER = &"c:\python312\python" -c "from plomclient.client import __version__; print(__version__)"
  - echo "Extracted version string '$VER'"
  - $NAME = "PlomClient-$VER.exe"
  - move dist\PlomClient*.exe $NAME
  - CertUtil -hashfile $NAME MD5 > md5sum.txt
  - ls $NAME
  - type md5sum.txt
  artifacts:
    paths:
    - PlomClient*.exe
    - md5sum.txt
    expire_in: 16 days