From b8dd9acb4e7ff159093d3f74b2016987a0ed6edf Mon Sep 17 00:00:00 2001 From: Francisco Rodriguez-Sanchez Date: Tue, 16 Jan 2024 11:32:34 +0100 Subject: [PATCH] add github action for pkgdown --- .github/workflows/pkgdown.yaml | 49 ++++++++++++++++++++++++++++++++++ .gitignore | 1 + DESCRIPTION | 2 +- _pkgdown.yml | 11 +------- 4 files changed, 52 insertions(+), 11 deletions(-) create mode 100644 .github/workflows/pkgdown.yaml diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..471fbbb --- /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: + branches: [main, master] + release: + types: [published] + workflow_dispatch: + +name: pkgdown + +jobs: + pkgdown: + timeout-minutes: 10 + 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@v3 + + - 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.4.1 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index 6c95fc0..fe7af43 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ output/ labeleR_output +docs diff --git a/DESCRIPTION b/DESCRIPTION index cef5f90..0d5ab30 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -20,7 +20,7 @@ License: MIT + file LICENSE Encoding: UTF-8 Roxygen: list(markdown = TRUE) RoxygenNote: 7.2.3 -URL: https://github.com/EcologyR/labeleR/ +URL: https://github.com/EcologyR/labeleR/, https://ecologyr.github.io/labeleR/ BugReports: https://github.com/EcologyR/labeleR/issues/ Depends: R (>= 3.5.0) diff --git a/_pkgdown.yml b/_pkgdown.yml index 817f8be..f0d124d 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,9 +1,5 @@ -# url: ~ -# template: -# bootstrap: 5 - +url: https://ecologyr.github.io/labeleR/ reference: - - title: Functions contents: - create_certificate_attendance @@ -12,9 +8,6 @@ reference: - create_herbarium_label - create_collection_label - create_tinylabel - - - - title: Example datasets contents: - attendance.table @@ -24,5 +17,3 @@ reference: - label.table - tiny.table - -