Skip to content

ci: whitelist new words and restore package-name ignore in spelling #3

ci: whitelist new words and restore package-name ignore in spelling

ci: whitelist new words and restore package-name ignore in spelling #3

Workflow file for this run

# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
release:
types: [published]
workflow_dispatch:
name: pkgdown
permissions: read-all
# Cancel a superseded run (e.g. a newer push to the same ref) so its minutes
# are not wasted completing.
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
pkgdown:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
# The deploy step pushes the built site to the gh-pages branch, so this
# job needs write access to contents (workflow-level read-all is
# overridden here).
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: r-lib/actions/setup-pandoc@v2
- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true
- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::pkgdown, local::.
needs: website
# dest_dir = "pkgdown" (not the default "docs") because _pkgdown.yml
# sets destination: pkgdown and docs/ holds the project plans.
- name: Build site
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE, dest_dir = "pkgdown")
shell: Rscript {0}
- name: Deploy to GitHub pages
if: github.event_name != 'pull_request'
uses: JamesIves/github-pages-deploy-action@v4
with:
clean: false
branch: gh-pages
folder: pkgdown