From 8b9ac8fd64f4ea2af8c9d5d0ed6c7d9740619091 Mon Sep 17 00:00:00 2001 From: CJ Yetman - RMI Date: Sat, 17 Aug 2024 14:57:51 +0200 Subject: [PATCH 1/2] add pkgdown site --- .Rbuildignore | 3 ++ .github/workflows/pkgdown.yaml | 50 ++++++++++++++++++++++++++++++++++ .gitignore | 1 + DESCRIPTION | 2 ++ _pkgdown.yml | 3 ++ 5 files changed, 59 insertions(+) create mode 100644 .github/workflows/pkgdown.yaml create mode 100644 _pkgdown.yml diff --git a/.Rbuildignore b/.Rbuildignore index 45abcde6..6effb72c 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -3,3 +3,6 @@ ^\.Rproj\.user$ ^\.github$ ^example\.config\.yml$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 00000000..8d5e4707 --- /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 + pull_request: + branches: main + release: + types: [published] + workflow_dispatch: + +name: pkgdown.yaml + +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 4f85f3c9..c4d34891 100644 --- a/.gitignore +++ b/.gitignore @@ -50,3 +50,4 @@ rsconnect/ *.DS_Store config.yml +docs diff --git a/DESCRIPTION b/DESCRIPTION index 2e579742..852763d2 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -41,6 +41,8 @@ Depends: License: MIT + file LICENSE RoxygenNote: 7.3.2 Suggests: + pkgdown, testthat (>= 3.0.0), writexl Config/testthat/edition: 3 +URL: https://rmi-pacta.github.io/workflow.multi.loanbook/ diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 00000000..a77ca3ec --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,3 @@ +url: https://rmi-pacta.github.io/workflow.multi.loanbook/ +template: + package: pacta.pkgdown.rmitemplate From 778b414ea821a001ee0dad739bc353adf92b452e Mon Sep 17 00:00:00 2001 From: CJ Yetman - RMI Date: Sat, 17 Aug 2024 15:08:15 +0200 Subject: [PATCH 2/2] depend on pacta.pkgdown.rmitemplate when building the website --- DESCRIPTION | 1 + 1 file changed, 1 insertion(+) diff --git a/DESCRIPTION b/DESCRIPTION index 852763d2..5d21ff9e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -45,4 +45,5 @@ Suggests: testthat (>= 3.0.0), writexl Config/testthat/edition: 3 +Config/Needs/website: rmi-pacta/pacta.pkgdown.rmitemplate URL: https://rmi-pacta.github.io/workflow.multi.loanbook/