From 619b8826b2a14259f8341459f79a4aa4a9881771 Mon Sep 17 00:00:00 2001 From: cbhurley Date: Wed, 24 Jul 2024 16:36:58 +0100 Subject: [PATCH] pkgdown site --- .Rbuildignore | 6 +++- .github/.gitignore | 1 + .github/workflows/pkgdown.yaml | 50 ++++++++++++++++++++++++++++++++++ .gitignore | 1 + DESCRIPTION | 1 + _pkgdown.yml | 4 +++ 6 files changed, 62 insertions(+), 1 deletion(-) create mode 100644 .github/.gitignore create mode 100644 .github/workflows/pkgdown.yaml create mode 100644 _pkgdown.yml diff --git a/.Rbuildignore b/.Rbuildignore index f91c806..98a5653 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,3 +1,7 @@ ^.*\.Rproj$ ^\.Rproj\.user$ -^README.Rmd \ No newline at end of file +^README.Rmd +^_pkgdown\.yml$ +^docs$ +^pkgdown$ +^\.github$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..c9f0165 --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,50 @@ +# 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 + +jobs: + pkgdown: + 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/github-pages-deploy-action@v4.5.0 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index 7487699..25718fe 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ .Ruserdata .DS_Store inst/doc +docs diff --git a/DESCRIPTION b/DESCRIPTION index 2a8e71d..b5d6756 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -37,3 +37,4 @@ Suggests: openintro Config/testthat/edition: 3 VignetteBuilder: knitr +URL: https://cbhurley.github.io/bullseye/ diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..3879ee5 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: https://cbhurley.github.io/bullseye/ +template: + bootstrap: 5 +