From c02cd4417b519a2fe5a5338e68ce67c2503f7170 Mon Sep 17 00:00:00 2001 From: Andreas Gammelgaard Damsbo Date: Thu, 16 Jan 2025 11:24:13 +0100 Subject: [PATCH] pkgdown page init --- .Rbuildignore | 4 +++ .github/.gitignore | 1 + .github/workflows/pkgdown.yaml | 49 ++++++++++++++++++++++++++++++++++ .gitignore | 1 + DESCRIPTION | 5 ++-- _pkgdown.yml | 4 +++ 6 files changed, 62 insertions(+), 2 deletions(-) create mode 100644 .github/.gitignore create mode 100644 .github/workflows/pkgdown.yaml create mode 100644 _pkgdown.yml diff --git a/.Rbuildignore b/.Rbuildignore index 46c6340..99a3872 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -8,3 +8,7 @@ ^inst/shiny-examples/casting/functions\.R$ ^functions\.R$ ^CODE_OF_CONDUCT\.md$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ +^dev$ 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..bfc9f4d --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,49 @@ +# 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: + 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 1bb73e9..df15ad7 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ dev/ app/rsconnect inst/shiny-examples/casting/functions.R functions.R +docs diff --git a/DESCRIPTION b/DESCRIPTION index e0fbcf8..12bd85d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -52,7 +52,8 @@ Imports: rlang, data.table, apexcharter, - teal.modules.general + teal.modules.general, + esquisse Suggests: styler, devtools, @@ -61,5 +62,5 @@ Suggests: roxygen2, pak, rsconnect -URL: https://github.com/agdamsbo/freesearcheR +URL: https://github.com/agdamsbo/freesearcheR, https://agdamsbo.github.io/freesearcheR/ BugReports: https://github.com/agdamsbo/freesearcheR/issues diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..12b9f32 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: https://agdamsbo.github.io/freesearcheR/ +template: + bootstrap: 5 +