##=============================================================================
##
##  Copyright (c) Kitware, Inc.
##  All rights reserved.
##  See LICENSE.txt for details.
##
##  This software is distributed WITHOUT ANY WARRANTY; without even
##  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
##  PURPOSE.  See the above copyright notice for more information.
##
##=============================================================================

.upload_doxygen_script: &upload_doxygen_script
  - chmod 400 $DOC_KEY_FILE
  - rsync -rtv --delete -e "ssh -i $DOC_KEY_FILE -o StrictHostKeyChecking=no" build/docs/doxygen/html/ "kitware@web.kitware.com:vtkm_documentation/$DOXYGEN_UPLOAD_REMOTE_PATH"

.build_doxygen_script: &build_doxygen_script
  - cmake --build "${CI_PROJECT_DIR}/build" --target docs/doxygen
  - cmake --build "${CI_PROJECT_DIR}/build" --target VTKmUsersGuideHTML
  - cmake --build "${CI_PROJECT_DIR}/build" --target VTKmUsersGuideLaTeX

.build_docs: &build_docs
  stage: build
  tags:
    - build
    - vtkm
    - docker
    - linux-x86_64
  before_script:
    - cmake -V -P .gitlab/ci/config/gitlab_ci_setup.cmake
    - ctest -VV -S .gitlab/ci/ctest_configure.cmake
  timeout:  30 minutes
  interruptible: true
  variables:
    CMAKE_BUILD_TYPE: Release
    VTKM_SETTINGS: "tbb+openmp+mpi+shared+docs"

build:docs-continuous:
  script:
    - *build_doxygen_script
  extends:
    - .build_docs
    - .cmake_build_artifacts
    - .run_automatically
    - .ubuntu2004_doxygen

build:docs-master:
  script:
    - *build_doxygen_script
    - *upload_doxygen_script
  environment:
    name: doxygen-nightly
    url: https://docs-m.vtk.org/nightly/
  rules:
    - if: '$CI_PROJECT_PATH == "vtk/vtk-m" && $CI_COMMIT_REF_NAME == "master"'
      when: on_success
    - when: never
  extends:
    - .build_docs
    - .cmake_build_artifacts
    - .ubuntu2004_doxygen
  variables:
    DOXYGEN_UPLOAD_REMOTE_PATH: "nightly"

build:docs-latest:
  script:
    - *build_doxygen_script
    - *upload_doxygen_script
  environment:
    name: doxygen-latest
    url: https://docs-m.vtk.org/latest/index.html
  rules:
    - if: '$CI_PROJECT_PATH == "vtk/vtk-m" && $CI_COMMIT_TAG'
      when: on_success
    - when: never
  extends:
    - .build_docs
    - .cmake_build_artifacts
    - .ubuntu2004_doxygen
  variables:
    DOXYGEN_UPLOAD_REMOTE_PATH: "latest"