gh-pages.yaml

# Workflow name
name: "Documentation Build"

# Event that must trigger the workflow
on:
  push:
    branches:
      - main # <- only on main branch

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest

    # Use bash instead of sh for conda activation
    defaults:
      run:
        shell: bash -l {0}

    steps:
      # Checkout the repository
      - name: "Checkout"
        uses: actions/checkout@v4

      # See https://github.com/conda-incubator/setup-miniconda#caching-environments

      # See https://github.com/marketplace/actions/setup-micromamba
      - name: install
        uses: mamba-org/setup-micromamba@v1.4.3
        with:
          environment-file: environment.yml
          environment-name: lidar_prod # activate the environment
          cache-environment: true
          cache-downloads: true
          generate-run-shell: true

      - name: replace BD_UNI credentials
        run: cp configs/bd_uni_connection_params/credentials_template.yaml configs/bd_uni_connection_params/credentials.yaml

      # 2. Sphinx part : install tool and dependencies
      - name: "Build Sphinx Doc"
        working-directory: ./docs/
        run: make html

      # 3. Déploiement sur les Github Pages

      - name: "Deploy Github Pages"
        uses: JamesIves/github-pages-deploy-action@3.7.1
        with:
          BRANCH: gh-pages # <- Branch where generated doc files will be commited
          FOLDER: ./docs/build/html/ # <- Dir where .nojekyll is created and from which to deploy github pages.