Skip to content

Commit

Permalink
initialize pkgdown
Browse files Browse the repository at this point in the history
  • Loading branch information
daranzolin committed Jul 26, 2024
1 parent 9c4134c commit dacbcc7
Show file tree
Hide file tree
Showing 7 changed files with 86 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@
^\.github$
^cran-comments\.md$
^CRAN-SUBMISSION$
^_pkgdown\.yml$
^docs$
^pkgdown$
50 changes: 50 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 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

permissions: read-all

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@v4

- 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.5.0
with:
clean: false
branch: gh-pages
folder: docs
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
.Rhistory
.RData
.Ruserdata
docs
inst/doc
8 changes: 6 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,14 @@ Imports:
tarchetypes,
targets,
withr
URL: https://github.com/daranzolin/sqltargets
URL: https://github.com/daranzolin/sqltargets,
https://daranzolin.github.io/sqltargets/
BugReports: https://github.com/daranzolin/sqltargets/issues
RoxygenNote: 7.2.1
Suggests:
testthat (>= 3.0.0),
RSQLite (>= 2.2.0)
RSQLite (>= 2.2.0),
knitr,
rmarkdown
Config/testthat/edition: 3
VignetteBuilder: knitr
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: https://daranzolin.github.io/sqltargets/
template:
bootstrap: 5

2 changes: 2 additions & 0 deletions vignettes/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*.html
*.R
19 changes: 19 additions & 0 deletions vignettes/intro-to-sqltargets.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "Introduction to sqltargets"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Introduction to sqltargets}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
)
```

```{r setup}
library(sqltargets)
```

0 comments on commit dacbcc7

Please sign in to comment.