Skip to content

Commit

Permalink
Add pkgdown site
Browse files Browse the repository at this point in the history
  • Loading branch information
gaborcsardi committed Nov 3, 2023
1 parent 874a078 commit 56e86e2
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 1 deletion.
4 changes: 4 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@
^.travis.yml$
^appveyor.yml$
^revdep$
^_pkgdown\.yml$
^docs$
^pkgdown$
^\.github$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
48 changes: 48 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# 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:
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
@@ -1,3 +1,4 @@
.Rproj.user
.Rhistory
.RData
docs
3 changes: 2 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Description: Specify debug messages as special string constants, and
control debugging of packages via environment variables.
License: MIT + file LICENSE
LazyData: true
URL: https://github.com/r-lib/debugme#readme
URL: https://github.com/r-lib/debugme#readme, https://r-lib.github.io/debugme/
BugReports: https://github.com/r-lib/debugme/issues
RoxygenNote: 6.0.1
Roxygen: list(markdown = TRUE)
Expand All @@ -21,3 +21,4 @@ Suggests:
testthat,
withr
Encoding: UTF-8
Config/Needs/website: tidyverse/tidytemplate
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: https://r-lib.github.io/debugme/
template:
bootstrap: 5

0 comments on commit 56e86e2

Please sign in to comment.