ci_cd.yml

name: Github CI-CD

on:
  pull_request:
  workflow_dispatch:
  push:
    tags:
      - "*"
    branches:
      - "main"
  schedule: # UTC at 0300
    - cron: "0 3 * * *"

env:
  MAIN_PYTHON_VERSION: '3.10'
  PACKAGE_NAME: 'pyaedt-examples'
  ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER) }}
  ON_CI: True
  PYAEDT_NON_GRAPHICAL: '1'
  PYAEDT_DOC_GENERATION: '1'

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  
  doc-style:
    name: Documentation style
    runs-on: ubuntu-latest
    steps:
      - uses: ansys/actions/doc-style@v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

# =================================================================================================
# vvvvvvvvvvvvvvvvvvvvvvvvvvvvvv    RUNNING ON SELF-HOSTED RUNNER    vvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
# =================================================================================================

  doc-build:
    name: Build documentation
    runs-on: [self-hosted, Windows, pyaedt-examples]
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ env.MAIN_PYTHON_VERSION }}
          use-cache: false

      - name: Create virtual environment
        run: |
          python -m venv .venv
          .venv\Scripts\Activate.ps1
          python -m pip install pip -U
          python -m pip install wheel setuptools -U
          python -c "import sys; print(sys.executable)"

      - name: Install project and documentation dependencies
        run: |
          .venv\Scripts\Activate.ps1
          pip install -r requirements/requirements_doc.txt

      # Use environment variable to keep the doctree and avoid redundant build for PDF pages
      - name: Create HTML documentation
        env:
          SPHINXBUILD_KEEP_DOCTREEDIR: "1"
        run: |
          .venv\Scripts\Activate.ps1
          . .\doc\make.bat html

      - name: Upload HTML documentation artifact
        uses: actions/upload-artifact@v4
        with:
          name: documentation-html
          path: doc/_build/html
          retention-days: 7

      # Use environment variable to remove the doctree after the build of PDF pages
      # Keeping doctree could cause an issue, see https://github.com/ansys/pyaedt/pull/3844/files
      - name: Create PDF documentation
        env:
          SPHINXBUILD_KEEP_DOCTREEDIR: "0"
        run: |
          .venv\Scripts\Activate.ps1
          . .\doc\make.bat pdf

      - name: Upload PDF documentation artifact
        uses: actions/upload-artifact@v4
        with:
          name: documentation-pdf
          path: doc/_build/latex
          retention-days: 7

      - name: Deploy
        if: contains(github.ref, 'refs/heads/main')
        uses: JamesIves/github-pages-deploy-action@v4.6.3
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          branch: gh-pages
          folder: doc/_build/html
          clean: true
          single-commit: true