docs.yml

name: Build, test, and upload docs

on:
  push:
    branches: [ main ]
  pull_request_target:
    branches: [ main ]
jobs:
  request_clearance: # First step
    runs-on: ubuntu-latest
    steps:
    - name: Request clearance
      run: echo For security reasons, all pull requests need to be cleared before running any automated CI involving tokens.

  docs:
    runs-on: ubuntu-latest
    needs: [request_clearance]
    environment:
      name: Integrate Pull Request # dummy environment
    timeout-minutes: 20
    steps:

    - uses: actions/checkout@v3
      with:
        ref: ${{ github.event.pull_request.head.sha }} # Check out the code of the PR

    - uses: actions/setup-python@v4
      with:
        python-version: '3.11'

    - name: Install dependencies and use default config
      run: |
        sudo apt-get update
        sudo apt install texlive texlive-latex-extra texlive-fonts-recommended dvipng cm-super --fix-missing
        python -m pip install --upgrade pip
        pip install wheel latex poetry
        poetry install
        cp config.defaults.yaml config.yaml
        poetry run scope-develop
    - name: Lint sources
      run: |
        poetry run scope-lint
    - name: Build docs
      env:
        KOWALSKI_INSTANCE_TOKEN: ${{ secrets.KOWALSKI_INSTANCE_TOKEN }}
        GLORIA_INSTANCE_TOKEN: ${{ secrets.GLORIA_INSTANCE_TOKEN }}
        MELMAN_INSTANCE_TOKEN: ${{ secrets.MELMAN_INSTANCE_TOKEN }}
      run: |
        poetry run scope-doc
    - name: Install SSH Client 🔑
      if: github.event_name == 'push' && github.repository_owner == 'ZwickyTransientFacility'
      uses: webfactory/ssh-agent@v0.4.1
      with:
        ssh-private-key: ${{ secrets.CI_DEPLOY_KEY }}

    - name: Deploy docs
      if: github.event_name == 'push' && github.repository_owner == 'ZwickyTransientFacility'
      uses: JamesIves/github-pages-deploy-action@releases/v4
      with:
        folder: doc/_build/html
        repository-name: ZwickyTransientFacility/scope-docs
        branch: master
        single-commit: true
        ssh-key: true