docs.yml

name: Documentation

on:
  pull_request:
    paths:
    - 'docs/**'
    - '.github/workflows/docs.yml'
  push:
    branches:
    - develop
    - main
    tags: '[0-9]+.[0-9]+.[0-9]+'
    paths:
    - 'docs/**'
    - '.github/workflows/docs.yml'
  release:
    types:
    - created

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

jobs:

  docs:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: ammaraskar/sphinx-action@master
      with:
        docs-folder: "docs/"
        build-command: make html dirhtml
    - uses: actions/upload-artifact@v3
      with:
        name: documentation
        path: docs/_build/html/

  # Deployment job
  deploy:
    if: github.ref == 'refs/heads/develop'
    environment:
      name: documentation
      url: "https://docs.artemis.cit.tum.de"
    runs-on: ubuntu-latest
    needs: docs
    steps:
      - name: Download artifact
        uses: actions/download-artifact@v3
        with:
          name: documentation
          path: public
      - name: Copy site to server
        uses: appleboy/scp-action@master
        with:
          host: docs.artemis.cit.tum.de
          username: ${{ secrets.DOCS_SSH_USER }}
          key: ${{ secrets.DOCS_SSH_KEY }}
          proxy_host: ${{ secrets.DEPLOYMENT_GATEWAY_HOST }}
          proxy_username: ${{ secrets.DEPLOYMENT_GATEWAY_USER }}
          proxy_key: ${{ secrets.DEPLOYMENT_GATEWAY_SSH_KEY }}
          proxy_port: ${{ secrets.DEPLOYMENT_GATEWAY_PORT }}
          source: "public"
          target: ${{ secrets.DOCS_HOME }}
      - name: Move site to www
        uses: appleboy/ssh-action@master
        with:
          host: docs.artemis.cit.tum.de
          username: ${{ secrets.DOCS_SSH_USER }}
          key: ${{ secrets.DOCS_SSH_KEY }}
          proxy_host: ${{ secrets.DEPLOYMENT_GATEWAY_HOST }}
          proxy_username: ${{ secrets.DEPLOYMENT_GATEWAY_USER }}
          proxy_key: ${{ secrets.DEPLOYMENT_GATEWAY_SSH_KEY }}
          proxy_port: ${{ secrets.DEPLOYMENT_GATEWAY_PORT }}
          script: |
              rm -rf ${{ secrets.DOCS_WWW }}/*
              mv -f public/* ${{ secrets.DOCS_WWW }}/