Skip to content

Commit 4742c40

Browse files
committed
pkgdown setup
1 parent 6e37aa5 commit 4742c40

File tree

6 files changed

+62
-2
lines changed

6 files changed

+62
-2
lines changed

.Rbuildignore

+5-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,8 @@
22
^.*\.Rproj$
33
^\.Rproj\.user$
44
^README\.Rmd$
5-
^\.lintr
5+
^\.lintr
6+
^_pkgdown\.yml$
7+
^docs$
8+
^pkgdown$
9+
^\.github$

.github/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

.github/workflows/pkgdown.yaml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
release:
8+
types: [published]
9+
workflow_dispatch:
10+
11+
name: pkgdown.yaml
12+
13+
permissions: read-all
14+
15+
jobs:
16+
pkgdown:
17+
runs-on: ubuntu-latest
18+
# Only restrict concurrency for non-PR jobs
19+
concurrency:
20+
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
21+
env:
22+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
23+
permissions:
24+
contents: write
25+
steps:
26+
- uses: actions/checkout@v4
27+
28+
- uses: r-lib/actions/setup-pandoc@v2
29+
30+
- uses: r-lib/actions/setup-r@v2
31+
with:
32+
use-public-rspm: true
33+
34+
- uses: r-lib/actions/setup-r-dependencies@v2
35+
with:
36+
extra-packages: any::pkgdown, local::.
37+
needs: website
38+
39+
- name: Build site
40+
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
41+
shell: Rscript {0}
42+
43+
- name: Deploy to GitHub pages 🚀
44+
if: github.event_name != 'pull_request'
45+
uses: JamesIves/[email protected]
46+
with:
47+
clean: false
48+
branch: gh-pages
49+
folder: docs

.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,5 @@ po/*~
4949
rsconnect/
5050
inst/doc
5151

52-
.lintr
52+
.lintr
53+
docs

DESCRIPTION

+1
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@ Roxygen: list(markdown = TRUE)
3131
RoxygenNote: 7.3.2
3232
LazyData: true
3333
VignetteBuilder: knitr
34+
URL: https://ngreifer.github.io/apm/

_pkgdown.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
url: ~
2+
template:
3+
bootstrap: 5
4+

0 commit comments

Comments
 (0)