Skip to content

Commit

Permalink
Fixes #1 build website (#9)
Browse files Browse the repository at this point in the history
* Fixes #1 build website

* Do not install addins
  • Loading branch information
pchelle authored Oct 24, 2024
1 parent da5910b commit 8b3a909
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 0 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
^LICENSE\.md$
^README\.Rmd$
^cran-comments\.md$
^\.github$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
42 changes: 42 additions & 0 deletions .github/workflows/update-website.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
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 }}

0 comments on commit 8b3a909

Please sign in to comment.