docs.yml

name: Docs

on: [push, pull_request]

defaults:
  run:
    shell: bash

jobs:
  docs-build:
    runs-on: ubuntu-latest

    permissions:
      id-token: write
      contents: read

    steps:
    - uses: actions/checkout@v3
    - uses: extractions/setup-just@v1
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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

    - name: Install dependencies
      run: |
        pip install ".[arrow]" \
          -r requirements/requirements-docs.txt \
          -r requirements/requirements-mxnet.txt \
          -r requirements/requirements-pytorch.txt \
          -r requirements/requirements-rotbaum.txt \
          -r requirements/requirements-extras-statsforecast.txt

    - name: Install Pandoc
      run: |
        sudo apt-get install pandoc

    - name: Build docs
      run: |
        SKIP_NOTEBOOKS=${{ github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'pr:docs-build-notebook') }}
        if [ $SKIP_NOTEBOOKS = true ]; then
          DOCS_BUILD_MODE=skip
        else
          DOCS_BUILD_MODE=release
        fi
        echo "Running in '$DOCS_BUILD_MODE' mode"
        just mode=$DOCS_BUILD_MODE docs

    - name: Configure AWS Credentials
      if: ${{ github.event_name == 'push' && ( github.ref_name == 'dev' || startsWith(github.ref_name, 'v0.')) }}
      uses: aws-actions/configure-aws-credentials@v2
      with:
        role-to-assume: arn:aws:iam::671929771060:role/WebsitePublisher
        role-session-name: docs-push
        aws-region: us-east-1

    - name: Publish docs
      if: ${{ github.event_name == 'push' }}
      run: |
        aws s3 sync docs/_build/html s3://gluonts-website/${GITHUB_REF#refs/heads/} --delete --acl bucket-owner-full-control