docs.yml

on:
  workflow_dispatch:
  push:
    branches: [master, docs]

name: Publish docs to GitHub Pages

jobs:
  build-deploy:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Check out repository
        uses: actions/checkout@v3

      # Pandoc is required for our `articles/style.qmd` document
      # It should be included with Quarto (since Quarto uses pandoc), but
      # our script does not find it in the PATH (?!), so we install it here.
      - name: Set up Pandoc
        uses: r-lib/actions/setup-pandoc@v2

      - name: Set up Quarto
        uses: quarto-dev/quarto-actions/setup@v2

      # Unfortunately, we need R to use knitr, which is required in
      # the `articles/styles` page...
      - name: Install R
        uses: r-lib/actions/setup-r@v2
        with:
          use-public-rspm: true

      - name: Install R Dependencies
        run: R -e 'install.packages(c("knitr", "rmarkdown"))'

      - name: Render and Publish
        uses: quarto-dev/quarto-actions/publish@v2
        with:
            path: docs
            target: gh-pages
            # Set custom username and email for better readability.
            GITHUB_USERNAME: "$GITHUB_ACTOR"
            GITHUB_EMAIL: "$GITHUB_ACTOR@users.noreply.github.com"
        env:
            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}