deploy-docs.yml

name: Publish Docs

on:
  pull_request:
  push:
    branches:
      - main
  release:
    types:
      - published

permissions:
  # Give the GITHUB_TOKEN write permission to open a PR with the changes to the switcher.json file.
  contents: write
  pull-requests: write

jobs:
  run:
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash -l {0}

    steps:
    - uses: actions/checkout@v4
      with:
        fetch-depth: 0

    - name: Setup Micromamba env
      uses: mamba-org/setup-micromamba@v2
      with:
        environment-name: TEST
        init-shell: bash
        create-args: >-
          python=3.12
          --file requirements.txt
          --file requirements-dev.txt

    - name: Install folium from source
      run: python -m pip install -e . --no-deps --force-reinstall

    - name: Build documentation
      run: |
        set -e
        pushd docs
        make clean html linkcheck
        popd

    - name: Update switcher and latest version
      if: ${{ github.event_name == 'release' }}
      run: |
        python docs/update_switcher.py --version ${{ github.ref_name }}

    - name: Create PR
      if: ${{ github.event_name == 'release' }}
      uses: peter-evans/create-pull-request@v7
      with:
        commit-message: "docs: Update switcher.json for ${{ github.ref_name }}"
        title: "docs: Update switcher.json for ${{ github.ref_name }}"
        body: "This PR updates the switcher.json file."
        branch: "docs/update-switcher-${{ github.ref_name }}"
        base: "main"
        labels: "documentation"

    - name: Publish to Github Pages on main
      if: ${{ github.ref == 'refs/heads/main' }}
      uses: peaceiris/actions-gh-pages@v4
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: docs/_build/html/
        destination_dir: dev
        keep_files: false

    - name: Publish to Github Pages on release (versioned)
      if: ${{ github.event_name == 'release' }}
      uses: peaceiris/actions-gh-pages@v4
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: docs/_build/html/
        destination_dir: ${{ github.ref_name }}

    - name: Publish to Github Pages on release (latest)
      if: ${{ github.event_name == 'release' }}
      uses: peaceiris/actions-gh-pages@v4
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: docs/_build/html/
        destination_dir: latest
        keep_files: false