Skip to content

Commit

Permalink
Add GitHub Actions workflow for pkgdown site build
Browse files Browse the repository at this point in the history
git push
  • Loading branch information
XiaoYan-Clarence committed Jun 27, 2024
1 parent 104b59f commit 5cb9863
Showing 1 changed file with 33 additions and 43 deletions.
76 changes: 33 additions & 43 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -1,50 +1,40 @@
# 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
name: Build pkgdown site

on:
push:
branches: [main, master]
branches:
- main
pull_request:
branches: [main, master]
release:
types: [published]
workflow_dispatch:

name: pkgdown

permissions: read-all
branches:
- main

jobs:
pkgdown:
build:
runs-on: ubuntu-latest
# Only restrict concurrency for non-PR jobs
concurrency:
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
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

- name: Build site
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
shell: Rscript {0}

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/[email protected]
with:
clean: false
branch: gh-pages
folder: docs
- uses: actions/checkout@v2

- name: Set up R
uses: r-lib/actions/setup-r@v2

- name: Install system dependencies
run: |
sudo apt-get install -y libxml2-dev
sudo apt-get install -y libssl-dev
sudo apt-get install -y libcurl4-openssl-dev
sudo apt-get install -y libgit2-dev
- name: Install R package dependencies
run: |
install.packages("remotes")
remotes::install_deps(dependencies = TRUE)
install.packages(c("tidyverse", "devtools"))
- name: Install pkgdown
run: install.packages('pkgdown')

- name: Build pkgdown site
run: Rscript -e 'pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)'
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

0 comments on commit 5cb9863

Please sign in to comment.