.gitlab-ci.yml

# SPDX-License-Identifier: CC0-1.0
# SPDX-FileCopyrightText: 2018-2023 Collabora, Ltd. and the Monado contributors

###############################################
# GENERATED - DO NOT EDIT
# see .gitlab-ci/ci.template, etc instead
###############################################

# Detached MR pipelines, needed due to https://gitlab.freedesktop.org/freedesktop/freedesktop/-/issues/438

# workflow:
#   rules:
#     - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
#     - if: $CI_PIPELINE_SOURCE == 'push'

variables:
  FDO_UPSTREAM_REPO: "monado/monado"

include:
  - project: "freedesktop/ci-templates"
    ref: 7811ba9814a3bad379377241c6c6b62d78b20eac
    file:
      - "/templates/debian.yml"
      - "/templates/ubuntu.yml"
      - "/templates/arch.yml"
  # - local: .gitlab-ci/containers/ci-container-prep.yml
  - local: .gitlab-ci/ci-rules.yml

stages:
  - container_prep
  - build
  - package
  - reprepro
  - pages
  - deploy


# # # 
###
# Windows container-related jobs (prep and usage)

.monado.common_variables.windows:vs2022:
  inherit:
    default: false
  variables:
    MONADO_WIN_BASE_TAG: "20230422.0"
    MONADO_WIN_MAIN_TAG: "20230422.0"
    MONADO_BASE_IMAGE_PATH: "win2022/vs2022_base"
    MONADO_MAIN_IMAGE_PATH: "win2022/vs2022"

.monado.variables.windows:vs2022:
  inherit:
    default: false
  extends:
    - .monado.common_variables.windows:vs2022
  variables:
    MONADO_IMAGE_PATH: "$MONADO_MAIN_IMAGE_PATH"
    FDO_DISTRIBUTION_TAG: "$MONADO_WIN_MAIN_TAG"
    MONADO_IMAGE: "$CI_REGISTRY_IMAGE/$MONADO_IMAGE_PATH:$FDO_DISTRIBUTION_TAG"
    MONADO_UPSTREAM_IMAGE: "$CI_REGISTRY/$FDO_UPSTREAM_REPO/$MONADO_IMAGE_PATH:$FDO_DISTRIBUTION_TAG"

# Shared container-building job
.monado.windows.container_prep:
  inherit:
    default: false
  tags:
    - windows
    - "2022"
    - shell
  variables:
    GIT_STRATEGY: fetch
  extends:
    - .container-rules

  stage: container_prep
  script:
    - |
      .gitlab-ci\windows\monado_container.ps1 -RegistryUri "$CI_REGISTRY" -RegistryUsername "$CI_REGISTRY_USER" -UserImage "$MONADO_IMAGE" -UpstreamImage "$MONADO_UPSTREAM_IMAGE" -Dockerfile "$DOCKERFILE" -BaseImage "$MONADO_BASE_IMAGE" -BaseUpstreamImage "$MONADO_UPSTREAM_BASE_IMAGE" -Verbose

# This container just installs Visual C++ Build Tools.
win:container_prep:base:
  extends:
    - .monado.windows.container_prep
    - .monado.common_variables.windows:vs2022
  variables:
    DOCKERFILE: Dockerfile.vs2022
    MONADO_IMAGE_PATH: ${MONADO_BASE_IMAGE_PATH}
    FDO_DISTRIBUTION_TAG: "$MONADO_WIN_BASE_TAG"
    MONADO_IMAGE: "$CI_REGISTRY_IMAGE/$MONADO_IMAGE_PATH:$FDO_DISTRIBUTION_TAG"
    MONADO_UPSTREAM_IMAGE: "$CI_REGISTRY/$FDO_UPSTREAM_REPO/$MONADO_IMAGE_PATH:$FDO_DISTRIBUTION_TAG"

# This container adds other deps
win:container_prep:
  extends:
    - .monado.windows.container_prep
    - .monado.variables.windows:vs2022
  needs:
    - win:container_prep:base
  variables:
    DOCKERFILE: Dockerfile.build
    MONADO_BASE_IMAGE: "$CI_REGISTRY_IMAGE/$MONADO_BASE_IMAGE_PATH:$MONADO_WIN_BASE_TAG"
    MONADO_UPSTREAM_BASE_IMAGE: "$CI_REGISTRY/$FDO_UPSTREAM_REPO/$MONADO_BASE_IMAGE_PATH:$MONADO_WIN_BASE_TAG"

# Base job to use a Windows build container
.monado.image.windows:
  tags:
    - windows
    - "2022"
    - docker
  extends:
    - .monado.variables.windows:vs2022
    - .build-rules
  image: $MONADO_IMAGE


# Variables for build and usage of Debian bullseye image
.monado.variables.debian:bullseye:
  variables:
    FDO_DISTRIBUTION_VERSION: "bullseye"
    FDO_DISTRIBUTION_TAG: "2023-04-07"

# Variables for build and usage of Debian bullseye-ndk image
.monado.variables.debian:bullseye-ndk:
  variables:
    FDO_DISTRIBUTION_VERSION: "bullseye"
    FDO_DISTRIBUTION_TAG: "2023-04-10.1"
    FDO_REPO_SUFFIX: ndk

# Variables for build and usage of Ubuntu focal image
.monado.variables.ubuntu:focal:
  variables:
    FDO_DISTRIBUTION_VERSION: "20.04"
    FDO_DISTRIBUTION_TAG: "2022-09-20.0"

# Variables for build and usage of Ubuntu jammy image
.monado.variables.ubuntu:jammy:
  variables:
    FDO_DISTRIBUTION_VERSION: "22.04"
    FDO_DISTRIBUTION_TAG: "2022-09-20.0"

# Variables for build and usage of Arch rolling image
.monado.variables.arch:rolling:
  variables:
    FDO_DISTRIBUTION_VERSION: "rolling"
    FDO_DISTRIBUTION_TAG: "2023-05-22.0"

###
# Container prep jobs
# Make Debian bullseye image
debian:bullseye:container_prep:
  stage: container_prep
  extends:
    - .container-rules
    - .monado.variables.debian:bullseye
    - .fdo.container-build@debian # from ci-templates

  variables:
    FDO_DISTRIBUTION_PACKAGES: 'build-essential ca-certificates clang-format cmake codespell curl debhelper devscripts doxygen dput-ng gettext-base git glslang-tools graphviz libavcodec-dev libbluetooth-dev libbsd-dev libcjson-dev libdbus-1-dev libegl1-mesa-dev libeigen3-dev libgl1-mesa-dev libglvnd-dev libgstreamer-plugins-base1.0-dev libgstreamer1.0-dev libhidapi-dev libopencv-dev libsdl2-dev libsystemd-dev libudev-dev libusb-1.0-0-dev libuvc-dev libv4l-dev libvulkan-dev libwayland-dev libx11-dev libx11-xcb-dev libxcb-randr0-dev libxrandr-dev libxxf86vm-dev ninja-build pandoc patch pkg-config python3 python3-click python3-pip unzip wget'
    FDO_DISTRIBUTION_EXEC: 'env FDO_CI_CONCURRENT=${FDO_CI_CONCURRENT} bash .gitlab-ci/i386_and_proclamation_container_prep.sh'

# Make Debian bullseye-ndk image
debian:bullseye-ndk:container_prep:
  stage: container_prep
  extends:
    - .container-rules
    - .monado.variables.debian:bullseye-ndk
    - .fdo.container-build@debian # from ci-templates

  variables:
    FDO_DISTRIBUTION_PACKAGES: 'ca-certificates cmake default-jdk-headless git glslang-tools libeigen3-dev meson ninja-build pkg-config python3 unzip wget'
    FDO_DISTRIBUTION_EXEC: 'env FDO_CI_CONCURRENT=${FDO_CI_CONCURRENT} bash .gitlab-ci/android_container_prep.sh'

# Make Ubuntu focal image
ubuntu:focal:container_prep:
  stage: container_prep
  extends:
    - .container-rules
    - .monado.variables.ubuntu:focal
    - .fdo.container-build@ubuntu # from ci-templates

  variables:
    FDO_DISTRIBUTION_PACKAGES: 'build-essential ca-certificates cmake curl debhelper devscripts dput-ng gettext-base git glslang-tools libavcodec-dev libbluetooth-dev libbsd-dev libcjson-dev libdbus-1-dev libegl1-mesa-dev libeigen3-dev libgl1-mesa-dev libglvnd-dev libgstreamer-plugins-base1.0-dev libgstreamer1.0-dev libhidapi-dev libopencv-dev libsdl2-dev libsystemd-dev libudev-dev libusb-1.0-0-dev libuvc-dev libv4l-dev libvulkan-dev libwayland-dev libx11-dev libx11-xcb-dev libxcb-randr0-dev libxrandr-dev libxxf86vm-dev ninja-build pandoc patch pkg-config python3 unzip wget'

# Make Ubuntu jammy image
ubuntu:jammy:container_prep:
  stage: container_prep
  extends:
    - .container-rules
    - .monado.variables.ubuntu:jammy
    - .fdo.container-build@ubuntu # from ci-templates

  variables:
    FDO_DISTRIBUTION_PACKAGES: 'build-essential ca-certificates cmake curl debhelper devscripts dput-ng gettext-base git glslang-tools libavcodec-dev libbluetooth-dev libbsd-dev libcjson-dev libdbus-1-dev libegl1-mesa-dev libeigen3-dev libgl1-mesa-dev libglvnd-dev libgstreamer-plugins-base1.0-dev libgstreamer1.0-dev libhidapi-dev libopencv-dev libsdl2-dev libsystemd-dev libudev-dev libusb-1.0-0-dev libuvc-dev libv4l-dev libvulkan-dev libwayland-dev libx11-dev libx11-xcb-dev libxcb-randr0-dev libxrandr-dev libxxf86vm-dev ninja-build pandoc patch pkg-config python3 reprepro unzip wget'

# Make Arch rolling image
arch:rolling:container_prep:
  stage: container_prep
  extends:
    - .container-rules
    - .monado.variables.arch:rolling
    - .fdo.container-build@arch # from ci-templates

  variables:
    FDO_DISTRIBUTION_PACKAGES: 'base-devel bc bluez-libs boost check clang cmake diffutils doxygen eigen ffmpeg fmt gcc git glew glfw-x11 glslang glu graphviz gtest gtk3 hidapi libbsd libusb libxrandr mesa meson ninja opencv patch pipewire-jack pkgconfig python-attrs python-setuptools python3 qt6-base v4l-utils vulkan-headers vulkan-icd-loader wayland wget wireplumber'
    FDO_DISTRIBUTION_EXEC: 'env FDO_CI_CONCURRENT=${FDO_CI_CONCURRENT} bash .gitlab-ci/install-arch-additional-deps.sh'


###
# Container usage base jobs

# Base for using Debian bullseye image
.monado.image.debian:bullseye:
  extends:
    - .monado.variables.debian:bullseye
    - .fdo.distribution-image@debian # from ci-templates
    - .build-rules


# Base for using Debian bullseye-ndk image
.monado.image.debian:bullseye-ndk:
  extends:
    - .monado.variables.debian:bullseye-ndk
    - .fdo.suffixed-image@debian # from ci-templates
    - .build-rules


# Base for using Ubuntu focal image
.monado.image.ubuntu:focal:
  extends:
    - .monado.variables.ubuntu:focal
    - .fdo.distribution-image@ubuntu # from ci-templates
    - .build-rules


# Base for using Ubuntu jammy image
.monado.image.ubuntu:jammy:
  extends:
    - .monado.variables.ubuntu:jammy
    - .fdo.distribution-image@ubuntu # from ci-templates
    - .build-rules


# Base for using Arch rolling image
.monado.image.arch:rolling:
  extends:
    - .monado.variables.arch:rolling
    - .fdo.distribution-image@arch # from ci-templates
    - .build-rules



# Style check job
format-and-spellcheck:
  extends:
    - .monado.image.debian:bullseye

  stage: build
  script:
    - scripts/format-and-spellcheck.sh
  artifacts:
    paths:
      - patches/
    expire_in: 1 week
    when: on_failure

# Verify REUSE compliance
reuse:
  extends:
    - .build-rules
  stage: build
  image:
    name: fsfe/reuse:latest
    entrypoint: [""]
  script:
    - reuse lint


debian:cmake:
  stage: build
  extends:
    - .monado.image.debian:bullseye
  before_script:
    - pushd doc/changes
    - proclamation build --overwrite vNEXT
    - popd

  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-cmake-build.sh
    - cd build && ctest --output-on-failure
  artifacts:
    paths:
      - build/doc/html/

debian:cmake-no-opencv:
  stage: build
  extends:
    - .monado.image.debian:bullseye
  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-cmake-build.sh -DBUILD_DOC=OFF -DXRT_HAVE_OPENCV=OFF
    - cd build && ctest --output-on-failure

debian:cmake-no-sdl2:
  stage: build
  extends:
    - .monado.image.debian:bullseye
  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-cmake-build.sh -DBUILD_DOC=OFF -DXRT_HAVE_SDL2=OFF
    - cd build && ctest --output-on-failure

debian:cmake-no-service:
  stage: build
  extends:
    - .monado.image.debian:bullseye
  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-cmake-build.sh -DBUILD_DOC=OFF -DXRT_FEATURE_SERVICE=OFF
    - cd build && ctest --output-on-failure

debian:cmake:32bit:
  stage: build
  extends:
    - .monado.image.debian:bullseye
  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-cmake-build.sh -DCMAKE_TOOLCHAIN_FILE=.gitlab-ci/i386.cmake -DXRT_HAVE_OPENCV=OFF
    - cd build && ctest --output-on-failure

ndk:armeabi-v7a:
  stage: build
  extends:
    - .monado.image.debian:bullseye-ndk
  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-cmake-build.sh -DANDROID_ABI=armeabi-v7a -DANDROID_PLATFORM=26 -DBUILD_DOC=OFF -DCMAKE_TOOLCHAIN_FILE=/opt/android-ndk/build/cmake/android.toolchain.cmake -DEigen3_DIR=/usr/lib/cmake/eigen3/ -DEIGEN3_INCLUDE_DIR=/usr/include/eigen3

ndk:arm64-v8a:
  stage: build
  extends:
    - .monado.image.debian:bullseye-ndk
  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-cmake-build.sh -DANDROID_ABI=arm64-v8a -DANDROID_PLATFORM=26 -DBUILD_DOC=OFF -DCMAKE_TOOLCHAIN_FILE=/opt/android-ndk/build/cmake/android.toolchain.cmake -DEigen3_DIR=/usr/lib/cmake/eigen3/ -DEIGEN3_INCLUDE_DIR=/usr/include/eigen3

android:spotlessCheck:
  stage: build
  extends:
    - .monado.image.debian:bullseye-ndk
  before_script:
    # For caching gradle stuff
    - export GRADLE_USER_HOME=`pwd`/.gradlehome

  variables:
    GRADLE_ARGS: "-Porg.gradle.daemon=false "
  cache:
    paths:
      - .gradlehome/wrapper
      - .gradlehome/caches

  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-gradle-build.sh spotlessCheck

android:outOfProcessDebug:
  stage: build
  extends:
    - .monado.image.debian:bullseye-ndk
  before_script:
    # For caching gradle stuff
    - export GRADLE_USER_HOME=`pwd`/.gradlehome

  variables:
    GRADLE_ARGS: "-Porg.gradle.daemon=false "
  cache:
    paths:
      - .gradlehome/wrapper
      - .gradlehome/caches

  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-gradle-build.sh assembleOutOfProcessDebug
  artifacts:
    paths:
      - src/xrt/targets/openxr_android/build/outputs/apk/outOfProcess

android:inProcessDebug:
  stage: build
  extends:
    - .monado.image.debian:bullseye-ndk
  before_script:
    # For caching gradle stuff
    - export GRADLE_USER_HOME=`pwd`/.gradlehome

  variables:
    GRADLE_ARGS: "-Porg.gradle.daemon=false "
  cache:
    paths:
      - .gradlehome/wrapper
      - .gradlehome/caches

  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-gradle-build.sh assembleInProcessDebug
  artifacts:
    paths:
      - src/xrt/targets/openxr_android/build/outputs/apk/inProcess

android:outOfProcessRelease:
  stage: build
  extends:
    - .monado.image.debian:bullseye-ndk
  before_script:
    # For caching gradle stuff
    - export GRADLE_USER_HOME=`pwd`/.gradlehome

  variables:
    GRADLE_ARGS: "-Porg.gradle.daemon=false "
  cache:
    paths:
      - .gradlehome/wrapper
      - .gradlehome/caches

  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-gradle-build.sh assembleOutOfProcessRelease
  artifacts:
    paths:
      - src/xrt/targets/openxr_android/build/outputs/apk/outOfProcess

android:inProcessRelease:
  stage: build
  extends:
    - .monado.image.debian:bullseye-ndk
  before_script:
    # For caching gradle stuff
    - export GRADLE_USER_HOME=`pwd`/.gradlehome

  variables:
    GRADLE_ARGS: "-Porg.gradle.daemon=false "
  cache:
    paths:
      - .gradlehome/wrapper
      - .gradlehome/caches

  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-gradle-build.sh assembleInProcessRelease
  artifacts:
    paths:
      - src/xrt/targets/openxr_android/build/outputs/apk/inProcess

ubuntu:focal:cmake:
  stage: build
  extends:
    - .monado.image.ubuntu:focal
  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-cmake-build.sh -DBUILD_DOC=OFF
    - cd build && ctest --output-on-failure

ubuntu:jammy:cmake:
  stage: build
  extends:
    - .monado.image.ubuntu:jammy
  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-cmake-build.sh -DBUILD_DOC=OFF
    - cd build && ctest --output-on-failure

arch:cmake:
  stage: build
  extends:
    - .monado.image.arch:rolling
  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-cmake-build.sh
    - cd build && ctest --output-on-failure

arch:cmake:clang:
  stage: build
  extends:
    - .monado.image.arch:rolling
  script:

    - .gitlab-ci/prebuild.sh
    - .gitlab-ci/ci-cmake-build.sh -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++
    - cd build && ctest --output-on-failure

# Windows build
windows:
  stage: build
  extends:
    - .monado.image.windows
  script:
    - ./.gitlab-ci/windows/monado_build.ps1 -Install -RunTests
  artifacts:
    when: always
    paths:
      - install
      - build/Testing/Temporary

# Packaging
.monado.packaging.conditions:
  rules:
    # Only the default branch of the "upstream" repo.
    - if: "$CI_PROJECT_PATH == $FDO_UPSTREAM_REPO && $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH"
      when: on_success
    # Otherwise, don't build packages.
    - when: never



debian:bullseye:package:
  extends:
    - .monado.image.debian:bullseye
    - .monado.packaging.conditions
  variables:
    GIT_STRATEGY: clone
    DEBFULLNAME: "Monado CI"
    DEBEMAIL: "ryan.pavlik@collabora.com"
    DISTRO: debian
    CODENAME: bullseye
    DEB_VERSION_SUFFIX: bpo11
  stage: package
  before_script:
    - git config --global user.name Monado CI
    - git config --global user.email ryan.pavlik@collabora.com
  script:
    - .gitlab-ci/prebuild.sh
    # Prep the source tree
    - git clean -dfx
    # Call this script to build binary and source packages.
    # Can try locally by exporting the right variables and passing -B to get only a binary package to avoid complaints.
    - .gitlab-ci/build-and-submit-package.sh
  artifacts:
    paths:
      - "incoming/"
    expire_in: 2 days

ubuntu:focal:package:
  extends:
    - .monado.image.ubuntu:focal
    - .monado.packaging.conditions
  variables:
    GIT_STRATEGY: clone
    DEBFULLNAME: "Monado CI"
    DEBEMAIL: "ryan.pavlik@collabora.com"
    DISTRO: ubuntu
    CODENAME: focal
    DEB_VERSION_SUFFIX: ubuntu2004
  stage: package
  before_script:
    - git config --global user.name Monado CI
    - git config --global user.email ryan.pavlik@collabora.com
  script:
    - .gitlab-ci/prebuild.sh
    # Prep the source tree
    - git clean -dfx
    # Call this script to build binary and source packages.
    # Can try locally by exporting the right variables and passing -B to get only a binary package to avoid complaints.
    - .gitlab-ci/build-and-submit-package.sh
  artifacts:
    paths:
      - "incoming/"
    expire_in: 2 days

ubuntu:jammy:package:
  extends:
    - .monado.image.ubuntu:jammy
    - .monado.packaging.conditions
  variables:
    GIT_STRATEGY: clone
    DEBFULLNAME: "Monado CI"
    DEBEMAIL: "ryan.pavlik@collabora.com"
    DISTRO: ubuntu
    CODENAME: jammy
    DEB_VERSION_SUFFIX: ubuntu2204
  stage: package
  before_script:
    - git config --global user.name Monado CI
    - git config --global user.email ryan.pavlik@collabora.com
  script:
    - .gitlab-ci/prebuild.sh
    # Prep the source tree
    - git clean -dfx
    # Call this script to build binary and source packages.
    # Can try locally by exporting the right variables and passing -B to get only a binary package to avoid complaints.
    - .gitlab-ci/build-and-submit-package.sh
  artifacts:
    paths:
      - "incoming/"
    expire_in: 2 days

reprepro:package:
  stage: reprepro
  extends:
    - .monado.image.ubuntu:jammy

    - .monado.packaging.conditions
  needs:
    - debian:bullseye:package
    - ubuntu:focal:package
    - ubuntu:jammy:package
  script:
    - bash .gitlab-ci/reprepro.sh
  artifacts:
    paths:
      - "repo/"
    expire_in: 2 days

###
# Pages
###
pages:
  stage: pages
  extends:
    - .monado.packaging.conditions
  needs:
    - debian:cmake
    - reprepro:package
  script:
    - mkdir -p public
    - mv build/doc/html/* public/
    - mv repo public/apt
  artifacts:
    paths:
      - public