.gitlab-ci.yml

# to use the env-var "GIT_CLONE_PATH", set the following in
# ./gitlab-runner/config.toml under [[runners]]:
#   [runners.custom_build_dir]
#     enabled = true
# This will prevent git clone conflicts for jobs ran in parallel

variables:
  GIT_DEPTH: 10
  GIT_CLONE_PATH: $CI_BUILDS_DIR/$CI_RUNNER_SHORT_TOKEN/$CI_PROJECT_PATH/$CI_COMMIT_REF_NAME/$CI_JOB_NAME/$CI_CONCURRENT_ID

stages:
  - info
  - build
  - check-cases
  - code-analysis
  - doc
  - deploy

show-env-vars:
  stage: info
  variables:
    GIT_STRATEGY: none
    SEP: "##################################################################"
    S00: "commit date - "
    S01: "project: ${CI_PROJECT_PATH}"
    S02: "branch: ${CI_COMMIT_REF_NAME}"
    S03: "commit: ${CI_COMMIT_SHA}"
    S04: "commit msg: ${CI_COMMIT_MESSAGE}"
    S05: "clone base path: "
    S06: "runner token: ${CI_RUNNER_SHORT_TOKEN}"
  script:
    - echo -e "${SEP}\n${S00}$(date)\n${SEP}\n${S01}\n${S02}\n${S03}\n${S04}\n${SEP}\n${S05}${GIT_CLONE_PATH}\n${S06}\n${SEP}"

cmake-gfortran102:
  stage: build
  script:
    - source hpc-module-loads/eve.gfortran102
    - source scripts/compile
    - source scripts/compile_debug
    - source scripts/compile_OpenMP
    - source scripts/compile_OpenMP_debug
  artifacts:
    paths:
    - edk
    - edk_debug
    - edk_openmp
    - edk_openmp_debug

cmake-gfortran122:
  stage: build
  script:
    - source hpc-module-loads/eve.gfortran122
    - source scripts/compile
    - source scripts/compile_debug
    - source scripts/compile_OpenMP
    - source scripts/compile_OpenMP_debug
  artifacts:
    paths:
    - edk
    - edk_debug
    - edk_openmp
    - edk_openmp_debug

cmake-intel2020b:
  stage: build
  script:
    - source hpc-module-loads/eve.intel2020b
    - source scripts/compile
    - source scripts/compile_debug
    - source scripts/compile_OpenMP
    - source scripts/compile_OpenMP_debug
  artifacts:
    paths:
    - edk
    - edk_debug
    - edk_openmp
    - edk_openmp_debug


cmake-intel2023b-classic:
  stage: build
  script:
    - source hpc-module-loads/eve.intel2023b-classic
    - source scripts/compile
    - source scripts/compile_debug
    - source scripts/compile_OpenMP
    - source scripts/compile_OpenMP_debug
  artifacts:
    paths:
    - edk
    - edk_debug
    - edk_openmp
    - edk_openmp_debug

check-gfortran102:
  when: always
  stage: check-cases
  needs:
    - job: cmake-gfortran102
      artifacts: true
  script:
    - source hpc-module-loads/eve.gfortran102
    - source scripts/pre_check
    - python -u edk_checks_run.py -l logs -e ../edk_debug ../edk ../edk_openmp_debug ../edk_openmp -t 4
  artifacts:
    when: always
    paths:
    - check/logs/

check-gfortran122:
  when: always
  stage: check-cases
  needs:
    - job: cmake-gfortran122
      artifacts: true
  script:
    - source hpc-module-loads/eve.gfortran122
    - source scripts/pre_check
    - python -u edk_checks_run.py -l logs -e ../edk_debug ../edk ../edk_openmp_debug ../edk_openmp -t 4
  artifacts:
    when: always
    paths:
    - check/logs/

check-intel2020b:
  when: always
  stage: check-cases
  needs:
    - job: cmake-intel2020b
      artifacts: true
  script:
    - source hpc-module-loads/eve.intel2020b
    - source scripts/pre_check
    - python -u edk_checks_run.py -l logs -e ../edk_debug ../edk ../edk_openmp_debug ../edk_openmp -t 4
  artifacts:
    when: always
    paths:
    - check/logs/

check-intel2023b-classic:
  when: always
  stage: check-cases
  needs:
    - job: cmake-intel2023b-classic
      artifacts: true
  script:
    - source hpc-module-loads/eve.intel2023b-classic
    - source scripts/pre_check
    - python -u edk_checks_run.py -l logs -e ../edk_debug ../edk ../edk_openmp_debug ../edk_openmp -t 4
  artifacts:
    when: always
    paths:
    - check/logs/

coverage:
  when: always
  stage: code-analysis
  needs: []
  script:
    # gcov is part of GCC
    - source hpc-module-loads/eve.chs-conda02
    # run cmake with coverage support
    - cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_WITH_COVERAGE=ON -B build
    - cmake --build build --parallel
    # run all check-case for coverage calculation
    - cmake --build build --target coverage
    # copy the output to a top-level folder
    - mkdir coverage
    - cp build/coverage/* coverage -R
    - lcov_cobertura build/coverage.info
  coverage: '/lines[\.]+\: (\d+\.\d+)\%/'
  artifacts:
    when: always
    reports:
      coverage_report:
        coverage_format: cobertura
        path: coverage.xml
    paths:
    - coverage

documentation:
  when: always
  stage: doc
  needs: []
  script:
    - source hpc-module-loads/eve.chs-conda02
    - module load GCC/12.2.0 texlive/20230904
    # use doxygen from the chs conda environment
    - if [ -f "version.txt" ]; then export PROJECT_NUMBER="$(cat version.txt)"; fi
    - doxygen doc/doxygen.config > doxygen_log_dev.txt 2>&1
    # create pdf documentation
    - cd latex/ && make > ../doxygen_latex_dev.txt 2>&1
    - cp refman.pdf ../html/edk_doc.pdf
    - cp refman.pdf ../edk_doc_dev.pdf
    - cd .. && mv html html_dev
    - mv doxygen_warn.txt doxygen_warn_dev.txt
  artifacts:
    name: "$CI_COMMIT_REF_NAME"
    paths:
      - html_dev
      - edk_doc_dev.pdf
      - doxygen_log_dev.txt
      - doxygen_latex_dev.txt
      - doxygen_warn_dev.txt

documentation_stable:
  when: always
  only:
    - main
  stage: doc
  needs: []
  variables:
    GIT_DEPTH: 0
  script:
    # doc for latest version tag
    - ml git-lfs
    - git checkout $(git describe --match "v*" --abbrev=0 --tags $(git rev-list --tags --max-count=1))
    - if [ ! -d "doc" ]; then git checkout $CI_COMMIT_REF_NAME; fi
    - source hpc-module-loads/eve.chs-conda02
    - module load GCC/12.2.0 texlive/20230904
    # use doxygen from the chs conda environment
    - if [ -f "version.txt" ]; then export PROJECT_NUMBER="$(cat version.txt)"; fi
    - doxygen doc/doxygen.config > doxygen_log_tag.txt 2>&1
    - cd latex/ && make > ../doxygen_latex_tag.txt 2>&1
    - cp refman.pdf ../html/edk_doc.pdf
    - cp refman.pdf ../edk_doc_tag.pdf
    - cd .. && mv html html_tag
    - mv doxygen_warn.txt doxygen_warn_tag.txt
  artifacts:
    name: "$CI_COMMIT_REF_NAME"
    paths:
      - html_tag
      - edk_doc_tag.pdf
      - doxygen_log_tag.txt
      - doxygen_latex_tag.txt
      - doxygen_warn_tag.txt

pages:
  only:
    - main
  stage: deploy
  dependencies:
    - documentation
    - documentation_stable
    - coverage
  script:
    # create public dir (remove if already present)
    - test -d public && rm -rf public
    - mkdir -p public
    # create the subdir
    - mkdir public/stable/
    - mkdir public/latest/
    # copy the doxygen generated html page to the public site
    - cp html_tag/* public/stable/ -R
    - cp html_dev/* public/latest/ -R
    # create an index.html that redirects to the main documentation (in stable folder)
    - cp doc/html_files/index.html public/
    # create the coverage site
    - mkdir -p public/coverage
    - cp coverage/* public/coverage/ -R
  artifacts:
    name: "$CI_COMMIT_REF_NAME"
    paths:
      - public
  when: always