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:
      - "v*"
    paths:
      - .github/workflows/docs.yaml
      - altdoc/**
      - man/**
      - R/**
      - src/**
      - vignettes/**
      - DESCRIPTION
      - README.md
  pull_request:
    branches:
      - main
    paths:
      - .github/actions/setup/action.yaml
      - .github/workflows/docs.yaml
      - altdoc/**
      - man/**
      - R/**
      - src/**
      - vignettes/**
      - DESCRIPTION
      - README.md
  workflow_dispatch:

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

env:
  LIBR_POLARS_FEATURES: "full_features"
  LIBR_POLARS_BUILD: "true"
  LIBR_POLARS_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@v4

      - name: Set rust target
        id: rust-target
        run: |
          if [ "${{ runner.os }}" == "Windows" ]; then
            echo "TARGET=x86_64-pc-windows-gnu" >>$GITHUB_OUTPUT
          else
            echo "TARGET=$(rustc -vV | grep host | cut -d' ' -f2)" >>$GITHUB_OUTPUT
          fi

      - uses: ./.github/actions/setup
        with:
          target: "${{ steps.rust-target.outputs.TARGET }}"
          token: "${{ secrets.GITHUB_TOKEN }}"

      - uses: actions/setup-python@v5
        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

        # altdoc uses quarto
      - uses: quarto-dev/quarto-actions/setup@v2

      - uses: r-lib/actions/setup-r-dependencies@v2
        with:
          extra-packages: any::rcmdcheck
          needs: dev,website

      - name: Get requirements
        run: |
          task setup-python-tools

      - name: Build docs
        run: task build-website

      - name: upload docs
        if: ${{ github.event_name == 'pull_request' }}
        uses: actions/upload-artifact@v4
        with:
          name: docs
          path: docs

      - uses: webfactory/ssh-agent@v0.9.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
          repository-name: rpolars/rpolars.github.io
          ssh-key: true
          clean-exclude: |
            .nojekyll