Fixes #1 build website (#9) #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Update website | |
on: | |
push: | |
branches: | |
- main | |
# The action needs permissions to update the branch | |
permissions: | |
contents: write | |
env: | |
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | |
jobs: | |
update-website: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Setup | |
uses: r-lib/actions/setup-r@v2 | |
with: | |
use-public-rspm: true | |
# No need to install ospsuite ecosystem | |
# because the job only needs to display the md reports as html pages | |
- name: Packages to build website | |
run: install.packages(c("rmarkdown", "pkgdown")) | |
shell: Rscript {0} | |
# The script temporarily create index and vignettes for pkgdown to build site | |
- name: Build pkgdown website | |
run: pkgdown::build_site(install = FALSE) | |
shell: Rscript {0} | |
- name: Deploy | |
uses: JamesIves/github-pages-deploy-action@v4 | |
# The deployment folder should match the name of the artifact. | |
# Clean is false to prevent removing release site | |
# only target folder of repo from gh-pages branch is updated | |
with: | |
folder: docs | |
clean: true | |
branch: gh-pages | |
target-folder: docs | |
token: ${{ secrets.GITHUB_TOKEN }} |