docs.yaml

# This workflow is a mix of:
# - https://github.com/pola-rs/r-polars/blob/main/.github/workflows/check.yaml
# - https://github.com/r-lib/actions/blob/v2-branch/examples/pkgdown.yaml
# - https://squidfunk.github.io/mkdocs-material/publishing-your-site/?h=deploy#material-for-mkdocs

name: docs

on:
  push:
    branches:
      - main
    tags:
      - "**" # Push events to every tag including hierarchical tags like v1.0/beta
  pull_request:
    branches:
      - main
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  RPOLARS_FULL_FEATURES: "true"
  RPOLARS_CARGO_CLEAN_DEPS: "true"
  RPOLARS_PROFILE: release

jobs:
  documentation:
    runs-on: ubuntu-latest
    env:
      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
      R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
      docs_key: ${{ secrets.DEPLOY_DOCS }}
      repo_token: ${{ secrets.GITHUB_TOKEN }}

    permissions:
      contents: write

    steps:
      - uses: actions/checkout@v3

      - uses: ./.github/actions/setup

      - name: find polars rust source/cache, used by Makevars in check step
        run: |
          echo "RPOLARS_RUST_SOURCE=${PWD}/src/rust" >> $GITHUB_ENV
        shell: bash

      - uses: actions/setup-python@v4
        with:
          python-version: 3.x

      - uses: r-lib/actions/setup-pandoc@v2
      - uses: r-lib/actions/setup-r@v2
        with:
          use-public-rspm: true
          Ncpus: 2

      - name: Get requirements
        run: |
          make requirements-r
          make requirements-py

      - name: Build docs
        run: make docs

      - uses: webfactory/ssh-agent@v0.6.0
        env: 
          DEPLOY_DOCS: ${{ secrets.DEPLOY_DOCS  }}
        if: ${{ (github.event_name != 'pull_request') && (github.repository_owner == 'pola-rs') }} 
        with:
          ssh-private-key: ${{ secrets.DEPLOY_DOCS }}

        # https://www.mkdocs.org/user-guide/deploying-your-docs/
      - name: Build site and deploy to GitHub pages
        env: 
          DEPLOY_DOCS: ${{ secrets.DEPLOY_DOCS  }}
        if: ${{ (github.event_name != 'pull_request') && (github.repository_owner == 'pola-rs') }} 
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          clean: true
          branch: main
          folder: docs/site
          repository-name: rpolars/rpolars.github.io
          ssh-key: true
          clean-exclude: |
            .nojekyll