Skip to content

Commit

Permalink
add github action for pkgdown
Browse files Browse the repository at this point in the history
  • Loading branch information
Pakillo committed Jan 16, 2024
1 parent e411aaa commit b8dd9ac
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 11 deletions.
49 changes: 49 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
output/
labeleR_output

docs
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
11 changes: 1 addition & 10 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# url: ~
# template:
# bootstrap: 5

url: https://ecologyr.github.io/labeleR/
reference:

- title: Functions
contents:
- create_certificate_attendance
Expand All @@ -12,9 +8,6 @@ reference:
- create_herbarium_label
- create_collection_label
- create_tinylabel



- title: Example datasets
contents:
- attendance.table
Expand All @@ -24,5 +17,3 @@ reference:
- label.table
- tiny.table



0 comments on commit b8dd9ac

Please sign in to comment.