check-vignette-warnings.yaml

# Run vignettes with `options(warn = 2)` to fail on warnings
on:
  push:
    branches: [main, master]
  pull_request:
    branches: [main, master]
  schedule:
    # * is a special character in YAML so you have to quote this string
    # Trigger once a week at 00:00 on Sunday
    - cron: "0 0 * * SUN"

name: check-vignette-warnings

jobs:
  check-vignette-warnings:
    runs-on: ubuntu-latest
    env:
      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

    steps:
      - uses: actions/checkout@v4

      - uses: r-lib/actions/setup-pandoc@v2
        with:
          pandoc-version: "latest"

      - uses: r-lib/actions/setup-r@v2
        with:
          r-version: "devel"
          use-public-rspm: true

      - uses: r-lib/actions/setup-r-dependencies@v2
        with:
          pak-version: devel
          upgrade: "TRUE"
          extra-packages: |
            local::.

      - name: Build vignettes
        run: |
          options(
            crayon.enabled = TRUE,
            # warnPartialMatchArgs = TRUE,
            # warnPartialMatchAttr = TRUE,
            # warnPartialMatchDollar = TRUE,
            warn = 2L
          )
          vignettes <- fs::dir_ls("vignettes/", glob = "*.Rmd", recurse = TRUE)
          purrr::walk(vignettes, rmarkdown::render)
        shell: Rscript {0}