From ce2c8e2c9428ea170486e78f37417e39ff9cf71c Mon Sep 17 00:00:00 2001 From: Dave Slager Date: Sun, 25 Feb 2024 15:30:08 -0800 Subject: [PATCH] update pkgdown ci --- .Rbuildignore | 1 + .github/workflows/pkgdown.yaml | 78 ++++++++++++++-------------------- .gitignore | 1 + DESCRIPTION | 1 + _pkgdown.yml | 4 ++ 5 files changed, 39 insertions(+), 46 deletions(-) diff --git a/.Rbuildignore b/.Rbuildignore index 5a38238f..54120bbe 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -12,3 +12,4 @@ CONTRIBUTING.md vignettes/validation/validation.yml ^man/figures/cheatsheets/* +^pkgdown$ diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml index bd22cb43..5769976f 100644 --- a/.github/workflows/pkgdown.yaml +++ b/.github/workflows/pkgdown.yaml @@ -1,66 +1,52 @@ +# 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 + branches: [main, master] + pull_request: + branches: [main, master] + release: + types: [published] + workflow_dispatch: name: pkgdown jobs: pkgdown: - runs-on: ubuntu-18.04 + runs-on: ubuntu-latest + # Only restrict concurrency for non-PR jobs + concurrency: + group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} env: - RSPM: https://packagemanager.rstudio.com/cran/__linux__/bionic/latest GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} - + permissions: + contents: write steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 - - uses: r-lib/actions/setup-r@v1 - id: install-r + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true - - uses: r-lib/actions/setup-tinytex@v1 + - uses: r-lib/actions/setup-tinytex@v2 - run: tlmgr --version - - run: tlmgr update -self - run: tlmgr install multirow - - uses: r-lib/actions/setup-pandoc@master + - uses: r-lib/actions/setup-r-dependencies@v2 with: - pandoc-version: '2.7.3' + extra-packages: any::pkgdown, local::. + needs: website - - name: Install pak and query dependencies - run: | - install.packages("pak", repos = "https://r-lib.github.io/p/pak/dev/") - saveRDS(pak::pkg_deps("local::.", dependencies = TRUE), ".github/r-depends.rds") + - name: Build site + run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) shell: Rscript {0} - - name: Restore R package cache - uses: actions/cache@v2 + - name: Deploy to GitHub pages 🚀 + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.5.0 with: - path: | - ${{ env.R_LIBS_USER }} - !${{ env.R_LIBS_USER }}/pak - key: ubuntu-18.04-${{ steps.install-r.outputs.installed-r-version }}-1-${{ hashFiles('.github/r-depends.rds') }} - restore-keys: ubuntu-18.04-${{ steps.install-r.outputs.installed-r-version }}-1- - - - name: Install system dependencies - if: runner.os == 'Linux' - run: | - pak::local_system_requirements(execute = TRUE) - pak::pkg_system_requirements("pkgdown", execute = TRUE) - shell: Rscript {0} - - - name: Install dependencies - run: | - pak::local_install_dev_deps(upgrade = TRUE) - pak::pkg_install("pkgdown") - shell: Rscript {0} - - - name: Install package - run: R CMD INSTALL . - - - name: Build and deploy pkgdown site - run: | - git config --local user.name "$GITHUB_ACTOR" - git config --local user.email "$GITHUB_ACTOR@users.noreply.github.com" - Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)' + clean: false + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index 97f97be5..95b38ab0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .Rproj.user .Rhistory inst/doc +docs diff --git a/DESCRIPTION b/DESCRIPTION index a9dfd9ae..eee65ccb 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -73,3 +73,4 @@ Imports: VignetteBuilder: knitr SystemRequirements: lua +URL: https://phuse-org.github.io/valtools/ diff --git a/_pkgdown.yml b/_pkgdown.yml index e69de29b..d14abe71 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: https://phuse-org.github.io/valtools/ +template: + bootstrap: 5 +