Skip to content

Commit 8045ed5

Browse files
committedMar 23, 2025
Add pkgdown website
1 parent f0fc039 commit 8045ed5

File tree

5 files changed

+62
-3
lines changed

5 files changed

+62
-3
lines changed
 

‎.Rbuildignore

+3
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,6 @@
55
^.github$
66
^README\.Rmd$
77
^\.github$
8+
^_pkgdown\.yml$
9+
^docs$
10+
^pkgdown$

‎.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/github-pages-deploy-action@v4.5.0
46+
with:
47+
clean: false
48+
branch: gh-pages
49+
folder: docs

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
.Ruserdata
55
inst/doc
66
.DS_Store
7+
docs

‎DESCRIPTION

+5-3
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ Description: Provides functions to deploy file changes across multiple GitHub
1212
repositories using the GitHub API. Allows synchronizing common files,
1313
CI workflows, or configurations across many repositories with a single command.
1414
License: AGPL (>= 3)
15-
Encoding: UTF-8
16-
Roxygen: list(markdown = TRUE)
17-
RoxygenNote: 7.3.2
15+
URL: https://r-pkg.thecoatlessprofessor.com/multideploy/, https://github.com/coatless-rpkg/multideploy
16+
BugReports: https://github.com/coatless-rpkg/multideploy/issues
1817
Imports:
1918
gh (>= 1.3.0),
2019
base64enc,
@@ -23,5 +22,8 @@ Suggests:
2322
testthat (>= 3.0.0),
2423
knitr,
2524
rmarkdown
25+
Encoding: UTF-8
26+
Roxygen: list(markdown = TRUE)
27+
RoxygenNote: 7.3.2
2628
Config/testthat/edition: 3
2729
VignetteBuilder: knitr

‎_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)